New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs (level 101): fix typos, punctuation, formatting #160
base: main
Are you sure you want to change the base?
Conversation
thanks for the PR :) were these changes auto-generated or assisted by some tooling? The sheer volume of it makes it hard to review it all. And I wouldn't want to merge until someone has gone through them all. |
|
||
![Pig Example](images/pig_example.png) | ||
|
||
Output: | ||
``` | ||
<pre><code> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does the backquote not work here? why introduce html tags?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Backticks (```) in lists render the multiline code blocks as run-on inline. (The below snap is from https://linkedin.github.io/school-of-sre/level101/big_data/evolution/)
SELECT roll_no, name FROM studentDB.studentDetails where section=’A’ limit 5; | ||
``` | ||
3. Example Presto query: | ||
<pre><code> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
have you verified this render as expected?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree it is huge to process. It's neither auto-generated nor assisted by any tooling. I've just read them line-by-line and compared against the rendered output as well. It does not alter the content. However, it includes capitalization, formatting, indentation and few typos. |
This PR includes significant edits to the Level 101 docs to improve the readability in the context of following: