Updated text to stress importance of the requirements
What does this MR do?
The update in the install documentation requirements section was made to express the importance of reviewing the system requirements to avoid issues during the install and use of GitLab.
BEFORE:
Before installing GitLab, make sure to check the requirements documentation which includes useful information on the supported Operating Systems as well as the hardware requirements.
AFTER:
Before installing GitLab, it is of critical importance to review the system requirements. The system requirements include details on the minimum hardware, software, database, and additional requirements to support GitLab.
Related issues
Author's checklist
-
Follow the Documentation Guidelines and Style Guide. -
If applicable, update the permissions table. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Apply the documentation label.
Review checklist
All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.
1. Primary Reviewer
-
Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
2. Technical Writer
-
Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.
3. Maintainer
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.