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

Add missing closing ``` for a code block [skip ci] #6563

Merged
merged 7 commits into from
Sep 15, 2022

Conversation

gerashegalov
Copy link
Collaborator

Fixes formatting bug from #6555

Signed-off-by: Gera Shegalov gera@apache.org

Fixes formatting bug from #6555 

Signed-off-by: Gera Shegalov <gera@apache.org>
@gerashegalov gerashegalov self-assigned this Sep 14, 2022
@gerashegalov gerashegalov added the documentation Improvements or additions to documentation label Sep 14, 2022
@gerashegalov gerashegalov added this to the Sep 5 - Sep 23 milestone Sep 14, 2022
@gerashegalov gerashegalov changed the title Add missing closing ```` for a code block Add missing closing ``` for a code block Sep 14, 2022
Copy link
Collaborator

@sameerz sameerz left a comment

Choose a reason for hiding this comment

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

I suggest adding a $ prompt character at the beginning of line 190, 202, 204, 206, 214, 233 and 255, as is done on line 242, and changing Bash to bash. While both render correctly in github, only the lowercase version renders properly in github pages.

docs/dev/shims.md Show resolved Hide resolved
@sameerz
Copy link
Collaborator

sameerz commented Sep 15, 2022

Screenshot showing how Bash and bash render in gh-pages
Screen Shot 2022-09-14 at 5 20 46 PM
Screen Shot 2022-09-14 at 5 20 25 PM

gerashegalov and others added 3 commits September 14, 2022 17:26
Co-authored-by: Sameer Raheja <sameerz@users.noreply.github.com>
Signed-off-by: Gera Shegalov <gera@apache.org>
Signed-off-by: Gera Shegalov <gera@apache.org>
docs/dev/shims.md Outdated Show resolved Hide resolved
Signed-off-by: Gera Shegalov <gera@apache.org>
sameerz
sameerz previously approved these changes Sep 15, 2022
sameerz
sameerz previously approved these changes Sep 15, 2022
Copy link
Collaborator

@sameerz sameerz left a comment

Choose a reason for hiding this comment

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

As you pointed out in https://github.com/DavidAnson/markdownlint/blob/v0.26.2/doc/Rules.md#md014 , commands that have no output do not need to be preceeded by a prompt ($). I'm ok as is or if the prompts are removed from commands without output.

Signed-off-by: Gera Shegalov <gera@apache.org>
Signed-off-by: Gera Shegalov <gera@apache.org>
@sameerz sameerz changed the title Add missing closing ``` for a code block Add missing closing ``` for a code block [skip ci] Sep 15, 2022
@sameerz
Copy link
Collaborator

sameerz commented Sep 15, 2022

build

@gerashegalov gerashegalov merged commit 887ce6b into branch-22.10 Sep 15, 2022
@gerashegalov gerashegalov deleted the fixShimsMDFormatting branch September 15, 2022 01:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants