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

[Documentation]Internews feedback: Add clarity on required expertise for installation #7972

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

JoGSal
Copy link

@JoGSal JoGSal commented Nov 13, 2024

Description

Feedback received through Internews highlighted the need to "Make it clear at the beginning of the documentation that intermediate Linux experience is required". This commit adds context on the Quickstart guide, the Installation guide, and the Getting started documentation.

Checks

Docs building

  • Compiles without warnings.

Code formatting and web optimization

  • Uses three spaces indentation.
  • Adds or updates meta descriptions accordingly.
  • Updates the redirects.js script if necessary (check this guide).

Writing style

  • Uses present tense, active voice, and semi-formal registry.
  • Uses short, simple sentences.
  • Uses bold for user interface elements, italics for key terms or emphasis, and code font for Bash commands, file names, REST paths, and code.

Feedback received through Internews highlighted the need to "Make it
clear at the beginning of the documentation that intermediate Linux
experience is required". This commit adds context on the Quickstart
guide, the Installation guide, and the Getting started documentation.
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