Add preliminary badging to Ecosystem docset
What does this MR do?
The GitLab Style Guide expects the H1 headline for all documentation pages to declare what versions of GitLab a feature is available in. These pages in the Ecosystem docset did not contain H1 badging:
modified: doc/administration/integration/terminal.md
modified: doc/api/services.md
modified: doc/development/integrations/jira_connect.md
modified: doc/integration/README.md
modified: doc/integration/akismet.md
modified: doc/integration/auth0.md
modified: doc/integration/azure.md
modified: doc/integration/bitbucket.md
modified: doc/integration/cas.md
modified: doc/integration/external-issue-tracker.md
modified: doc/integration/facebook.md
modified: doc/integration/github.md
modified: doc/integration/gitlab.md
modified: doc/integration/gmail_action_buttons_for_gitlab.md
modified: doc/integration/google.md
modified: doc/integration/jenkins_deprecated.md
modified: doc/integration/oauth2_generic.md
modified: doc/integration/omniauth.md
modified: doc/integration/openid_connect_provider.md
modified: doc/integration/recaptcha.md
modified: doc/integration/salesforce.md
modified: doc/integration/shibboleth.md
modified: doc/integration/slash_commands.md
modified: doc/integration/trello_power_up.md
modified: doc/integration/twitter.md
modified: doc/user/admin_area/settings/project_integration_management.md
modified: doc/user/project/integrations/bamboo.md
modified: doc/user/project/integrations/bugzilla.md
modified: doc/user/project/integrations/custom_issue_tracker.md
modified: doc/user/project/integrations/discord_notifications.md
modified: doc/user/project/integrations/emails_on_push.md
modified: doc/user/project/integrations/hangouts_chat.md
modified: doc/user/project/integrations/hipchat.md
modified: doc/user/project/integrations/index.md
modified: doc/user/project/integrations/irker.md
modified: doc/user/project/integrations/jira.md
modified: doc/user/project/integrations/jira_cloud_configuration.md
modified: doc/user/project/integrations/jira_integrations.md
modified: doc/user/project/integrations/jira_server_configuration.md
modified: doc/user/project/integrations/mattermost.md
modified: doc/user/project/integrations/mattermost_slash_commands.md
modified: doc/user/project/integrations/microsoft_teams.md
modified: doc/user/project/integrations/mock_ci.md
modified: doc/user/project/integrations/overview.md
modified: doc/user/project/integrations/redmine.md
modified: doc/user/project/integrations/servicenow.md
modified: doc/user/project/integrations/services_templates.md
modified: doc/user/project/integrations/slack.md
modified: doc/user/project/integrations/unify_circuit.md
modified: doc/user/project/integrations/webex_teams.md
modified: doc/user/project/integrations/webhooks.md
modified: doc/user/project/integrations/youtrack.md
It's quite possible that I have the information wrong. For the full set of available badges, see https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#available-product-tier-badges
Related issues
Related to technical-writing#373 (closed) where I'm onboarding to this group.
Author's checklist (required)
-
Follow the Documentation Guidelines and Style Guide. - If you have Developer permissions or higher:
-
Ensure that the product tier badge is added to doc's h1
. -
Apply the documentation label, plus: - The corresponding DevOps stage and group labels, if applicable.
-
development guidelines when changing docs under
doc/development/*
,CONTRIBUTING.md
, orREADME.md
. -
development guidelines and Documentation guidelines when changing docs under
development/documentation/*
. - development guidelines and Description templates (.gitlab/*) when creating/updating issue and MR description templates.
-
Assign the designated Technical Writer.
-
Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.
When applicable:
-
Update the permissions table. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Add the product tier badge accordingly. -
Add GitLab's version history note(s). -
Add/update the feature flag section.
Review checklist
All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.
1. Primary Reviewer
-
Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
2. Technical Writer
-
Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage. -
Ensure docs metadata are present and up-to-date. -
Ensure Technical Writing and documentation are added. -
Add the corresponding docs::
scoped label. -
If working on UI text, add the corresponding UI Text
scoped label. -
Add twdoing when starting work on the MR. -
Add twfinished if Technical Writing team work on the MR is complete but it remains open.
-
For more information about labels, see Technical Writing workflows - Labels.
For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:
- Clear typos, like
this is a typpo
. - Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.
For more information, see our documentation on Merging a merge request.
3. Maintainer
-
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. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.