docs: rewrap comments in code blocks to not overflow on desktop #17837
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.
Checklist:
This PR is a QoL fix for documentation accessed from a desktop machine.
![image](https://private-user-images.githubusercontent.com/321364/322445375-f929fb54-4731-4e0d-b804-43289a38cd3c.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjI4MjYzNDUsIm5iZiI6MTcyMjgyNjA0NSwicGF0aCI6Ii8zMjEzNjQvMzIyNDQ1Mzc1LWY5MjlmYjU0LTQ3MzEtNGUwZC1iODA0LTQzMjg5YTM4Y2QzYy5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjQwODA1JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI0MDgwNVQwMjQ3MjVaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT05MGRhMzdlM2I3NDgzM2IzYjIwYTAwNDQ2MTgzNDU3M2MzMjYzMDBlNTgyMGFiMzU3NWViMzkwOWVkOWM1ZmMzJlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCZhY3Rvcl9pZD0wJmtleV9pZD0wJnJlcG9faWQ9MCJ9.8y68ejC7G2c6HB3rt1O7ORW0B0NnvoBOCf651I0cxMQ)
![image](https://private-user-images.githubusercontent.com/321364/322445806-3d54978a-8509-4730-9dca-0903825fd2ac.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjI4MjYzNDUsIm5iZiI6MTcyMjgyNjA0NSwicGF0aCI6Ii8zMjEzNjQvMzIyNDQ1ODA2LTNkNTQ5NzhhLTg1MDktNDczMC05ZGNhLTA5MDM4MjVmZDJhYy5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjQwODA1JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI0MDgwNVQwMjQ3MjVaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT1mYmYxMmQwNGE1NzQyNWRmZDI2YzIzYTk1ZmI2ZTFkOGNhZjk0OWJhMDExMzY5ZjcxYWVjNmQ2ODEzNGJlMGU1JlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCZhY3Rvcl9pZD0wJmtleV9pZD0wJnJlcG9faWQ9MCJ9.yQRfjfxIQmDdCe1T8iLjNR65znv2D7JhR9Lrjhi3Mak)
As of now, code blocks have a lot of horizontal overflows:
some of them are very unfortunate (comment states "... except for Deployment and StatefulSet"):
What I've did is to rewrap all overflowing comments in yaml code blocks so every valuable comment/note is on screen. Blocks still overflow when there are lengthy code rows, my rationale is this isn't too much a problem as if you're studying you want to read the comments and then copy the code for further analysis.
What do you think? I've suffered a lot when I first studied Argo CD so I hope this small change will improve the lives of those who will follow me :)
thank you, regards