Add third option for handling external repos
What does this MR do?
Now that I'm back, I've read through the discussion in How to manage development docs for "other" proj... (gitlab-docs#1229 - closed) and we should also document a third option for handling docs in external repos: a landing page in the gitlab
repo that points outward to the full documentation.
This option is currently in use for https://docs.gitlab.com/ee/user/project/repository/vscode.html for these reasons:
- The extension's release cadence does not match the GitLab release cadence.
- The extension's documentation does not adhere fully to GitLab corporate tone and style. (I've been chipping away at that problem; it's better than it was.)
- The extension docs currently can't pass the linting rules in the
gitlab
project, and due to some formatting required for inclusion in the VS Code extension repository, it may never pass. - BUT - and I agreed with @phikai and @viktomas here - the project deserved better findability within GitLab's docs.
In gitlab-pages!718 (comment 918792933) another of my groups came to a different decision regarding GitLab Pages. Those docs could be cleaned up to meet our style standards, and weren't subject to the same release cadence problems the VS Code extension had. Different needs, different result.
Related issues
- Related to How to manage development docs for "other" proj... (gitlab-docs#1229 - closed)
- Related to Small refinements to GitLab developer docs navi... (gitlab-docs!2867 - merged)
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.