Fix Markdown formatting in ecosystem readme files #13235
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.
Fix inconsistent indentation in ecosystem readme files which is causing the second code block to be indented in GitHub's Markdown renderer while the first is not. This is fixed by indenting the first code block using three spaces, matching the second code block.
Make the text formatting between the two list items consistent by adding a line break between the second list item and its corresponding code block. This does not affect how the file is rendered in GitHub's Markdown renderer, but it is an inconsistent text-formatting style between the two list items.
Remove trailing whitespace from two lines in the "docker" ecosystem readme file.
What are you trying to accomplish?
I am attempting to fix a visual inconsistency with how the ecosystem readme files are displayed on GitHub. In the readme file for many ecosystems the second code block is indented while the first is not. This appears to be caused by inconsistent indentation in the code blocks between the two list items. The first code block is indented with two spaces while the second is indented with three spaces. Increasing the indent of the first code block to match the indent of the second code block appears to fix the issue.
I also noticed inconsistent text formatting between the two list items. There is a line break between the first list item and its corresponding code block, but not between the second list item and its corresponding code block. I added a line break between the second list item and its corresponding code block.
My editor automatically removed trailing whitespace from two lines in the
docker
ecosystem readme file.Anything you want to highlight for special attention from reviewers?
I can't think of anything to highlight for special attention. I did notice additional inconsistencies between different readme files (one example: some tag the code blocks with
shell
, some withbash
, while most don't tag the code blocks at all). My focus was on the visual indentation of the two code blocks, so I fixed the indentation, added line break, and removed the trailing whitespace.How will you know you've accomplished your goal?
I can view the readme files on my branch and fork and see that the indentation of the two code blocks is now consistent.
Checklist
I have not added new code or updated existing code, so I have not attempted to run the complete test suite. I assume that readme files fall outside the scope of the complete test suite. Apologies if that is not the case, let me know and I'll run the complete test suite.