Sunset workflow index page
The Workflow index (readme) page https://docs.gitlab.com/ee/workflow/README.html is simply a long bulleted list of links:
- Some point to content within the /workflow path.
- Some point to locations elsewhere in the documentation.
This page and the linked content within the /workflow path should be analyzed to determine a course of action such as improving this page (for example, renaming it and adding context and better navigation), or removing it (and moving other /workflow pages to a better location), or otherwise improving the page and restructuring content.
Problem to solve
The Workflow index offers a poor experience because:
- It lacks a meaningful introduction contextualizing the content.
- It only offers a long list of features with links which is hard to navigate - there are no clear groupings, relevant info (e.g. a functionality or goal instead of merely a feature name), etc.
We need to ensure there are practical routes for users to find all linked content and, in doing so, improve or remove the page.
Proposal
Evaluate the links by placing them in a table with columns for:
- Linked text
- Target page title
- Path/file
- URL
- Parent feature (if any; e.g. Issue Weight can be considered part of Issues)
- Stage, Group (these columns can help point to logical groupings to use)
- Whether the content is inside or outside /workflow
- Evaluation of current location
- Recommended new location (can divide into MVC fixes vs further follow-up structure work)
If possible, we should err on the side of moving content out of /workflow first before considering substantial edits to other linked sections, so that the project is more iterative.
E.g. MVC may be improvement to the Workflow page; next, move /workflow content; next sunset Workflow page (and/or restructure other content locations first).
Who can address the issue
A GitLab technical writer
Other links/references
There was interest from Sid (see thread in #CEO (GitLab team members only)) so inform him when done.
Final Location List
Source | Destination |
---|---|
workflow/forking_workflow.md |
user/project/repository/forking_workflow.md |
workflow/file_finder.md |
user/project/repository/file_finder.md |
workflow/git_annex.md |
administration/git_annex.md |
workflow/lfs/lfs_administration.md |
administration/lfs/lfs_administration.md |
workflow/lfs/manage_large_binaries_with_git_lfs.md |
administration/lfs/manage_large_binaries_with_git_lfs.md |
workflow/lfs/migrate_from_git_annex_to_git_lfs.md |
administration/lfs/migrate_from_git_annex_to_git_lfs.md |
workflow/gitlab_flow.md |
topics/gitlab_flow.md |
workflow/issue_weight.md |
user/project/issues/issue_weight.md |
workflow/notifications.md |
user/profile/notifications.md |
workflow/releases.md |
user/project/releases/index.md#add-release-notes-to-git-tags |
workflow/repository_mirroring.md |
user/project/repository/repository_mirroring.md |
workflow/shortcuts.md |
user/shortcuts.md |
workflow/time_tracking.md |
user/project/time_tracking.md |
workflow/timezone.md |
administration/timezone.md |
workflow/todos.md |
user/todos.md |
workflow/workflow.md |
gitlab-basics/feature_branch_workflow.md |