Create dedicated page for rails console
What does this MR do?
'Run this on the rails console' is used extensively in our docs.
There needs to be single place where 'starting a rails console' is documented, as the procedure for Omnibus, Source, Kubernetes and Docker all different slightly.
This was attempted before. However
- An audit of the troubleshooting docs identified a second single source of truth!
- Five months on, it's clearer to me that our docs refer to the rails console a fair amount.
- Its own page, with an entry in the side menu, makes it findable in its own right.
step 1
This MR starts by proposing a dedicated page within Administration/Operations.
next steps in this MR
If this looks ok, I'll then
-
Add it to the menus in gitlab-docs in a dependent MR. -
changing doc locations -
Remove dupe content from administration/troubleshooting/debug.md
andadministration/troubleshooting/navigating_gitlab_via_rails_console.md
-
Find and fix all the broken links in docs.
For this iteration, the kubernetes content will stay where it is, and the docker content doesn't, I think, exist anywhere yet.
Related issues
Author's checklist (required)
-
Follow the Documentation Guidelines and Style Guide. - If you have
developer
access or higher (for example, GitLab team members or Core Team members)-
Apply the documentation label, plus: - The corresponding DevOps stage and group label, 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 GitLab's version history note(s). -
Add the product tier badge. -
Add/update the feature flag section. -
If you're changing document headings, search doc/*
,app/views/*
, andee/app/views/*
for old headings replacing with the new ones to avoid broken anchors.
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 Technical Writing, documentation, and a docs::
scoped label are added. -
Add docs-only when the only files changed are under doc/*
. -
Add twdoing when starting work on the MR. -
Add twfinished if Technical Writing team work on the MR is complete but it remains open.
-
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.