Docs: Add a note of Omnibus baseline storage req
What does this MR do?
Under the storage section of the hardware requirements doc, this warns of how much space the Omnibus package takes up itself.
This addition was motivated by a customer ticket (internal) where they did not have enough space on the filesystem for the package. I felt that having it mentioned somewhere would be valuable, especially in cases like this, where we could provide a link to help them understand what is needed.
Related issues
Author's checklist
- Consider taking the GitLab Technical Writing Fundamentals course
-
Follow the: -
Ensure that the product tier badge is added to topic's h1
. -
Request a review based on the: - The documentation page's metadata.
- The associated Technical Writer.
If you are only adding documentation, do not add any of the following labels:
~"feature"
~"frontend"
~"backend"
~"bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Review checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead of Default behavior
, say something likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure GDK
. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
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.
Edited by Andrew Conrad