Edited top-level page for language
What does this MR do?
This MR begins to implement the language we agreed to in the word list.
This MR also removes the Mermaid diagram, because the text says it's about how the containers are built. This information would be for a developer who is generating the containers, not for someone who is deploying the solution, I think?
The goal should be to quickly get people to the details of how to implement and configure the solution. We can move the diagram to a development page if that makes sense. (If so, please let me know where.)
Related issues
Related to: technical-writing#642
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.
Merge request reports
Activity
changed milestone to %15.4
added docsimprovement documentation maintenancerefactor typemaintenance labels
assigned to @sselhorn
Suggested Reviewers (beta)
The individuals below may be good candidates to participate in the review based on various factors.
You can use slash commands in comments to quickly assign
/assign_reviewer @user1
.Suggested Reviewers @marcel.amirault
,@sselhorn
,@cnorris
,@axil
,@ngaskill
If you do not believe these suggestions are useful, please apply the label Bad Suggested Reviewer. You can also provide feedback for this feature on this issue:
https://gitlab.com/gitlab-org/gitlab/-/issues/357923
.Automatically generated by Suggested Reviewers Bot - an experimental ML-based recommendation engine created by ~"group::applied ml".
1 Message This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. Documentation review
The following files require a review from a technical writer:
doc/install/cloud_native/index.md
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
Dangeradded Technical Writing devopssystems sectioncore platform labels
requested review from @WarheadsSE and @dorrino
Hi @dorrino @WarheadsSE I'm going to start going through the docs and standardizing the language, but because this is the top-level page, I'd like you to review. I'm not sure I have the description correct, and would love your opinion.
See the header description of this MR for what I did and why. Thanks!
requested review from @dianalogan and removed review request for @WarheadsSE and @dorrino
- Resolved by Diana Logan
Hi @dianalogan Because the team is quite busy, and in the interest of speed, can you review this MR? I'd like to proceed with updating some of these high-level pages.
As I mentioned in slack: Step 1 is to clean up the existing content on the page. Step 2 will be to consider whether the content is in the right location.
Please let me know if you have questions. Thanks!
mentioned in issue technical-writing#642
mentioned in commit 9abfd3e7
added workflowstaging-canary label
added workflowcanary label and removed workflowstaging-canary label
added workflowstaging label and removed workflowcanary label
added workflowproduction label and removed workflowstaging label
added workflowpost-deploy-db-staging label and removed workflowproduction label
added workflowpost-deploy-db-production label and removed workflowpost-deploy-db-staging label
added releasedcandidate label
added releasedpublished label and removed releasedcandidate label