Optimize the cheat sheet to be in a printable form factor #14903
Optimize the cheat sheet to be in a printable form factor #14903
Conversation
Ancairon
requested review from
andrewm4894,
cakrit and
tkatsoulas
as code owners
Co-authored-by: Austin S. Hemmelgarn <austin@netdata.cloud>
| **disk.io**, **disk.ops**, and **disk.backlog** are all contexts. | ||
| **disk.io**, **disk.ops**, and **disk.backlog** are all contexts. --> | ||
|
|
||
| --- |
There was a problem hiding this comment.
These --- are probably added by mistake.
There was a problem hiding this comment.
They are line breaks, docusaurus doesn't render them, allows for the bottom of the site page (form, edit this page etc.) to be on a separate PDF page.
There was a problem hiding this comment.
We have more things on a .md then than only work in docusaurus. The printing instructions are like this too.
Suggestion: Put some things you need in comments in the markdown and do some additional processing in learn to produce the .mdx as it needs to be, stripping the comment start/end like we had discussed.
There was a problem hiding this comment.
<br> elements used instead to achieve this, @cakrit if we don't care about having those in the last page I could just remove the line breaks. I think it is smart for the user to just discard the last page
There was a problem hiding this comment.
Keep in mind, guys: one needs to adjust these new lines every time they do changes (add/remove text). It sounds a bit chore.
There was a problem hiding this comment.
I agree, but that means that if you save as a PDF then you have some weird stuff at the bottom of the page without those line breaks.
There was a problem hiding this comment.
Doesn't look like a problem to me, but you and @cakrit decide.
|
I wasn't clear on the request, I apologize. A useful cheatsheet is one that fits in a single printable page, which means tiny fonts. No need to bother printing on multiple pages, it won't help. |
|
So I suggest to take out the printing stuff completely, if we can't make it a single page and just leave in the improvements you did. |
|
@cakrit, I changed the title, I think a fitting one is I steered clear of using the word "common" because on Learn the first page after this category overview is called "Common configuration changes". |
4 participants
Summary
Closes netdata/learn#1597
This PR tries to make the cheat sheet be again in a printable form.
The sections left out were commented out and some info is condensed to fit A4 pages.
The goal is to be able to save as PDF using your web browser's built-in function.
I'd be happy to discuss what you think should/shouldn't be in this cheat sheet, I used the commands that I seemed to look for when deploying Netdata into my homelab, so maybe you got other things that you deem are necessary to be in this array of pages.
Just keep in mind, that this has to be the least pages possible, and stuff like the drop down in the start helps with space when collapsed and printed.
I went ahead and saved the cheat sheet in a PDF by right clicking in the page and selecting "print", here's the result:
Netdata cheat sheet.pdf
The sections are arranged in a way that would make sense for each page to be a standalone, and the link for the API page was spelled out in full, as you cant click a paper page 😄
The links for the individual sections I deemed best to put them in the dropdown, to save space in the printed form, as once printed they are just text.
If one doesn't want to print on paper, then he will not collapse the dropdown and save as PDF.