Skip to content

Create dedicated page for rails console

Ben Prescott_ requested to merge docs-bprescott-20200722-rcons into master

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

For this iteration, the kubernetes content will stay where it is, and the docker content doesn't, I think, exist anywhere yet.

Related issues

#228961 (closed)

Author's checklist (required)

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:

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.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Ben Prescott_

Merge request reports