Review and update Auto DevOps documentation
The documentation for Auto DevOps contains outdated screenshots and copy. We should audit the following pages and ensure they are up to date with the most relevant information:
- https://gitlab.com/help/topics/autodevops/index.md
- https://gitlab.com/help/topics/autodevops/quick_start_guide.md
See the description in gitlab-design#525 (closed) for detailed information of where docs are outdated.
Whenever possible, we should remove screenshots as they can quickly become outdated which can confuse users.
Proposal
1. Outdated screenshots in the documentation
The interface UI of the screenshot in the documentation is not the same as the one the user sees in the product. It gives the impression that the the documentation is not reliable.
Recommendation
Audit https://gitlab.com/help/topics/autodevops/quick_start_guide.md and https://gitlab.com/help/topics/autodevops/index.md and make sure all screenshots are up to date with the latest UI and workflow changes.
2. Outdated information in the documentation
The documentation tells users to Create on Google Kubernetes Engine but the copy displayed in the application UI reads Create new Cluster on GKE.
For example: The documentation tells users to add a base Domain under Settings > CI/CD > Auto Devops, but the option has been moved to Operations > Kubernetes.
Audit https://gitlab.com/help/topics/autodevops/quick_start_guide.md and https://gitlab.com/help/topics/autodevops/index.md and make sure all information is up to date with the latest UI and workflow changes.
3. Make the Quick Guide easier to spot in the documentation
Although we provide a comprehensive amount of documentation around CI/CD and Auto DevOps, the task of reading and understanding the requirements for setting up a project can become tiring. Allow for users to jump into the task first-hand.
Recommendation
Update the Auto DevOps docs page https://gitlab.com/help/topics/autodevops/index.md to have the Quick Start
guide placed on top of the page.
4. Clarify which projects are enabled by default
https://gitlab.com/help/topics/autodevops/index.md#enabled-by-default says the following:
Starting with GitLab 11.3, the Auto DevOps pipeline is enabled by default for all projects.
Should this say for all new projects? During Rayana's path in gitlab-design#525 (closed), it was enabled for her already.