Reorder executor tables to surface actively developed executors first
What does this MR do?
Reorders content in the executors index page to make it easier for users to identify and adopt the actively developed executors (Docker, Docker Autoscaler, Instance, Kubernetes).
Changes
Structure and organization
- Added
## Actively developed executorsheading to group Docker, Docker Autoscaler, Instance, and Kubernetes descriptions - Added
## Executors in maintenance modeheading to group Shell, SSH, Custom, and Docker Machine descriptions, with a brief explanation of what maintenance mode means - Moved executor descriptions to appear before the compatibility chart
- Moved the Git requirements section to the end of the page and renamed it from "Prerequisites for non-Docker executors" to "Git requirements for non-Docker executors"
Executor lists
- Reordered the non-active executor list and placed Docker Machine last, immediately before its deprecated label, to visually separate it from the others
Flowchart
- Moved the flowchart above the selection table so users reach the faster decision tool first
- Added
(maintenance mode)label to the SSH node in the flowchart - Added a warning callout after the flowchart to flag the SSH executor's maintenance mode status and suggest the Shell executor as an alternative for local shell-based builds
Tables
- Reordered columns in the selection table and compatibility chart so actively developed executors (Docker, Docker Autoscaler, Instance, Kubernetes) appear first
- Added a maintenance mode note above both the selection table and compatibility chart
- Renumbered footnotes in the selection table to follow reading order based on the new column arrangement
- Renumbered footnotes in the supported systems by shells table to follow reading order
Related issues
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 availability details are 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 you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
- 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.
- The headings should be something you'd do a Google search for. Instead of
- Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
Edited by Roshni Sarangadharan