Skip to content
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

Open
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

grjan7
Copy link

@grjan7 grjan7 commented May 2, 2024

This PR includes significant edits to the Level 101 docs to improve the readability in the context of following:

  • formatting of code snippets inline and in blocks
  • capitalization of SQL commands in the code blocks to differentiate them from dbs, tables, columns and fields
  • typos
  • added tab spaces to indent sublists
  • added links
  • punctuation

@sanketplus
Copy link
Collaborator

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>
Copy link
Collaborator

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?

Copy link
Author

@grjan7 grjan7 May 5, 2024

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/)

backquote

SELECT roll_no, name FROM studentDB.studentDetails where section=’A’ limit 5;
```
3. Example Presto query:
<pre><code>
Copy link
Collaborator

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?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I've verfied the rendered output.

Live page

backquote

Locally rendered page

pre code

@grjan7
Copy link
Author

grjan7 commented May 5, 2024

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.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants