Moving and redirecting content
What does this MR do?
This MR takes a bunch of disparate information and attempts to start putting it in files that have better names.
File | Details | What I did |
---|---|---|
Previously: ci/cloud_deployment/ecs/quick_start_guide.md Now: ci/cloud_deployment/ecs/deploy_to_aws_ec2.md |
Deploy to AWS ECS. | Redirected to have a better file name. |
ci/cloud_deployment/index.md | This page has both EC2 and ECS. | The ECS stuff is partly duplicated with the page listed above. A further MR should de-dupe this info. |
topics/autodevops/index.md | This page has a topic called Quick Start . |
I updated the links in the topic to point to the new pages. |
Previously: topics/autodevops/quick_start_guide.md Now: topics/autodevops/cloud_deployments/auto_devops_with_gke.md |
This page is about Auto DevOps and GKE. | Redirected to have a better file name. |
Previously: topics/autodevops/requirements.md Now: topics/autodevops/cloud_deployments/auto_devops_with_ecs.md and topics/autodevops/cloud_deployments/ec2.md |
This page had EC2 and ECS content. | I pulled out the content and put in autodevops/cloud_deployments folder. This page also had a topic called Auto DevOps requirements for Amazon EC2. I deleted, because it duplicated info on the EC2 page. |
Related issues
Related to: #364306
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"
~"backend"
~"type::bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Reviewer's 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. -
Ensure a release milestone is set. - 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 reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Suzanne Selhorn