Modernize documentation on setting up a development environment
What does this MR do?
The current documentation on setting up a development environment is out of date, and is not a great user experience. This MR aims to help fix this by:
- Instructing to use the official GitLab CE Nightly docker image.
- Previously the documentation stated to use a debian buster image, but the nightly packages are only built for Ubuntu.
- This also provides a much nicer experience to the user compared to manually installing omnibus within a docker container as the user can avoid dealing with the manual intervention associated with the necessary multiple failed installations
- Reorders the section so that the important "Docker container specific items" section isn't at the bottom of section.
- Adds a section on how to run chefspec tests locally.
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 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 Kenneth Chu