Writing guidelines reorg and updates/corrections #7319
+501
−452
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…and Health Checks
* [update] Securing Nginx With ModSecurity (#7167) Fixes: #6803 * [NEW] Getting Started with HAProxy Part 2: HTTP Load Balancing (#7095) * Getting Started with HAProxy Part 2: HTTP Load Balancing * Tech Edit 1 * Tech Edit 2 * Tech Edit 3 * Tech Edit 4 * Copy edits --------- Co-authored-by: Nathan Melehan <[email protected]> * [update] January Marketplace doc updates (#7178) * jan marketplace distro& instruction * rabbitmq lts add * review for January Marketplace release * review for January Marketplace release --------- Co-authored-by: Magda Sulik <[email protected]> * Update theme (#7179) - Update onetrust geolocation Co-authored-by: Nathan Melehan <[email protected]> --------- Co-authored-by: Rajakavitha Kodhandapani <[email protected]> Co-authored-by: Adam Overa <[email protected]> Co-authored-by: Nathan Melehan <[email protected]> Co-authored-by: hmorris3293 <[email protected]> Co-authored-by: Magda Sulik <[email protected]>
[Release] v1.361.0
[Release Candidate] v1.362.0
[Release Candidate] v1.363.0
[Release Candidate] v1.364.0
[Release] v1.365.0
[Release Candidate] v1.366.0
[Release Candidate] v1.367.0
[Release] v1.368.0
[Release] v1.369.0
[Release] v1.370.0
[Release] v1.371.0
[Release Candidate] v1.372.0
[Release] v1.373.0
[Release] v1.374.0
[Release Candidate] v1.375.0
[Release] v1.376.0
[Release Candidate] v1.377.0
[Release] v1.378.0
[Release Candidate] v1.379.0
[Release Candidate] v1.380.0
[Release Candidate] v1.381.0
[Release Candidate] v1.382.0
[Release Candidate] v1.383.0
[Release] v1.384.0
[Release Candidate] v1.385.0
Modified wording for font sizes.
Defined sequential for ordered lists.
DHBR2
commented
Aug 8, 2025
| #### Nested Content Within Lists | ||
|
|
||
| 1. Log back in as `testuser`: | ||
| To remain consistent across all of our guides, nested content should be indented *four* spaces and a blank line should be used above and below the content. Our Markdown processor assumes nested content starts directly below the *first* character in the text of the list item above it. With this in mind, it's important to indent the text portion of the list item to match that four space indent. In practice, there should be *two* spaces after the number (for ordered lists) and *three* spaces after the bullet for unordered lists. If this spacing is not respected, the nested content may not render properly. |
There was a problem hiding this comment.
What does "Our Markdown processor..." refer to? Hugo?
DHBR2
commented
Aug 8, 2025
| ### Tabs | ||
| Using a tabbed interface allows you to separate content into user-selectable tabs. This can be used to provide specific instructions for different versions of a software application (like MySQL 5.7 or .8), different operating systems (like macOS, Windows, or a Linux distribution), or different user tools (like the Cloud Manager, Linode CLI, or Linode API). |
There was a problem hiding this comment.
Suggest removing the last set of parentheses.
DHBR2
commented
Aug 8, 2025
| ### Files | ||
|
|
||
| Use the *file shortcode* to present code examples, code snippets, and other text file contents in a guide. This shortcode renders the file content with line numbering, a specified filepath, syntax highlighting, and line highlighting. Unlike other shortcodes (e.g. `content`, `note`, `caution`, etc), the file shortcode should be referenced with Markdown's *code fence* syntax. | ||
| Use the *file shortcode* to present code examples, code snippets, and other text file contents in a guide. This shortcode renders the file content with line numbering, a specified filepath, syntax highlighting, and line highlighting. Unlike other shortcodes (e.g., `content`, `note`, `caution`, etc.), the file shortcode should be referenced with Markdown's *code fence* syntax. |
There was a problem hiding this comment.
I don't understand the last sentence in this paragraph but left it in. Does this just mean to change the syntax to Markdown syntax?
Removed extra spacing.
Correct spelling and spacing errors.
More spelling errors fixed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Completed reorganization of content to correspond to the guide instructions.
Reworded some outdated content.
Replaced links that were not working.
Modernized some content.