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

STP-3553: Change command prompts to match docs-csm #123

Merged
merged 1 commit into from
Sep 11, 2023
Merged

Conversation

jld-dehn-hpe
Copy link
Collaborator

Summary and Scope

Switched to the command prompt approach used in docs-csm. The command itself does not include the prompt, but the step or paragraph which introduces the command is annotated with where the command should be executed. This allows the admin to easily copy and paste the entire code block to get the command they want to run.

Issues and Related PRs

  • Resolves STP-3553
  • Change will also be needed in release/2.6

Testing

Lint and spell check

Pull Request Checklist

  • Version number(s) incremented, if applicable
  • Copyrights updated
  • License file intact
  • Target branch correct
  • CHANGELOG.md updated
  • Testing is appropriate and complete, if applicable
  • HPC Product Announcement prepared, if applicable

Copy link
Contributor

@haasken-hpe haasken-hpe left a comment

Choose a reason for hiding this comment

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

When we remove the command prompt from the code blocks, we need to still differentiate between the command that the user must execute and the example output of that command.

I left some suggestions on how to handle that. You can also check with the writer for docs-csm to make sure my suggestion is reasonable and aligned with the strategy used there.

docs/about_sat/introduction.md Outdated Show resolved Hide resolved
docs/about_sat/introduction.md Outdated Show resolved Hide resolved
docs/external_system.md Outdated Show resolved Hide resolved
docs/external_system.md Outdated Show resolved Hide resolved
docs/external_system.md Outdated Show resolved Hide resolved
docs/external_system.md Outdated Show resolved Hide resolved
docs/external_system.md Outdated Show resolved Hide resolved
docs/install.md Outdated Show resolved Hide resolved
docs/install.md Show resolved Hide resolved
docs/install.md Show resolved Hide resolved
Copy link
Contributor

@haasken-hpe haasken-hpe left a comment

Choose a reason for hiding this comment

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

My comments are minor. The bulk of them are just suggestions that instead of specifying the bash language for example output, we just use screen. Technically, I don't think screen is a real supported language according to the GitHub-flavored Markdown docs and the Linguist languages.yml it links to. But it seems to be a convention we use. We could probably use text instead of screen and get the same effect where syntax highlighting does not occur.

docs/about_sat/introduction.md Outdated Show resolved Hide resolved
docs/about_sat/introduction.md Outdated Show resolved Hide resolved
docs/about_sat/sat_in_csm.md Outdated Show resolved Hide resolved
docs/dashboards/SAT_Grafana_Dashboards.md Outdated Show resolved Hide resolved
docs/dashboards/SAT_Grafana_Dashboards.md Outdated Show resolved Hide resolved
docs/usage/sat_bootprep.md Outdated Show resolved Hide resolved
docs/usage/sat_bootprep.md Outdated Show resolved Hide resolved
docs/usage/sat_bootprep.md Outdated Show resolved Hide resolved
docs/usage/sat_bootprep.md Outdated Show resolved Hide resolved
docs/usage/sat_bootprep.md Outdated Show resolved Hide resolved
@jld-dehn-hpe jld-dehn-hpe changed the title STP-3533: Change command prompts to match docs-csm STP-3553: Change command prompts to match docs-csm Sep 11, 2023
Signed-off-by: Jessica Dehn <jessica.dehn@hpe.com>
@jld-dehn-hpe
Copy link
Collaborator Author

/backport release/2.6

@github-actions
Copy link

Backporting into branch release/2.6 was successful. New PR: #124

@jld-dehn-hpe jld-dehn-hpe merged commit ad375d7 into main Sep 11, 2023
5 checks passed
@jld-dehn-hpe jld-dehn-hpe deleted the STP-3553 branch September 11, 2023 21:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants