Update docs to link out to VS Code extension
What does this MR do?
Starts the process of linking a few CI docs out to either 1) the new vscode.md
page in the gitlab
docset, or the relevant parts of https://marketplace.visualstudio.com/items?itemName=GitLab.gitlab-workflow (the official docs for the extension).
@marcel.amirault suggested these three pages, and I've added the parts I'm comfortable with, but I have concerns about one of the pages:
- https://docs.gitlab.com/ee/ci/index.html#references (maybe rename header)
- https://docs.gitlab.com/ee/ci/lint.html (relates to the
Validate your GitLab CI configuration.
)- https://docs.gitlab.com/ee/ci/pipelines/ (relates to
View the status of your pipeline
feature)
-
ci/index.md
- these changes made sense to me. -
ci/pipelines/index.md
I made some guesses, but I think we're OK overall. -
ci/lint.md
- This page talks about linting with a completely different tool. To me, this feels like a complete page restructuring, and I think Marcel is better-suited than I am to make the decision about what to do. (If this work needs to spin off, I'm fine with that.)
Related issues
Closes #343552 (closed)
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 Amy Qualls