docs: Consistent sh vs. console syntax highlighting #27
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
|
Can one of the admins verify this patch? |
openshift-ci-robot
added
needs-ok-to-test
wking
force-pushed
the
console-highlighting
branch
from
1715bca to
54fb231
Compare
GitHub uses Linuguist for syntax highlighting [1], and Linuguist defines two related grammars: * Shell (alias 'sh') [2], which applies to POSIX and similar shell languages. * ShellSession (alias 'console') [3], which extends the Shell grammar with support for prompts and command output as you would usually see in an interactive shell session. This commit consistently uses 'sh' to highlight blocks which contain only shell commands (without prompts or output). And it uses 'console' to highlight blocks which contain prompts, commands, and output. I've also removed prompts blocks which contain no output, because in the no-output cases that approach seemed more popular within this repository. I've also standardised on the 'sh' alias, where this repository previously used both 'sh' and 'shell'. I've also added continuation prompts (PS2) to the long describe-auto-scaling-groups example, to keep the continued command from being marked up as output. And I've replaced the terminal \ continuation there with a terminal |; we need a pipe anyway so we might as well save a character ;). [1]: https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting [2]: https://github.com/github/linguist/blob/v6.2.0/lib/linguist/languages.yml#L4317-L4378 [3]: https://github.com/github/linguist/blob/v6.2.0/lib/linguist/languages.yml#L4379-L4390
wking
force-pushed
the
console-highlighting
branch
from
54fb231 to
ed9a89f
Compare
Contributor
|
/lgtm |
Contributor
|
/ok-to-test |
openshift-ci-robot
removed
the
needs-ok-to-test
Contributor
|
@wking: The following test failed, say
DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
Member
Author
|
The e2e-aws is the same operator Instantiate the template e2e-aws into the operator namespace and wait for any pods to complete as seen in #29. But this time the error message is: |
This was referenced Aug 27, 2018
This was referenced Nov 8, 2018
stbenjam
pushed a commit
to stbenjam/installer
that referenced
this pull request
Feb 10, 2021
Add a manifest and ImageStream info for images needed by the CBO
mkumatag
added a commit
to mkumatag/installer
that referenced
this pull request
Jul 28, 2021
Update default values to proceed with install
zaneb
pushed a commit
to zaneb/openshift-installer
that referenced
this pull request
Apr 29, 2022
Improve service URL handling
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
GitHub uses Linuguist for syntax highlighting, and Linuguist defines two related grammars:
Shell(aliassh), which applies to POSIX and similar shell languages.ShellSession(aliasconsole), which extends theShellgrammar with support for prompts and command output as you would usually see in an interactive shell session.This commit consistently uses
shto highlight blocks which contain only shell commands (without prompts or output). And it usesconsoleto highlight blocks which contain prompts, commands, and output.I've also removed prompts blocks which contain no output, because in the no-output cases that approach seemed more popular within this repository.
I've also standardised on the
shalias, where this repository previously used bothshandshell.