Skip to content

docs: commands for translating hashed repo path +SSOT for rails console

Ben Prescott_ requested to merge bprescott-hashedstorage-20200205 into master

What does this MR do?

1: repository storage types

cc: @dblessing

In !24185 (merged) the matter of how to locate the project on hashed storage arose.

https://docs.gitlab.com/ee/administration/repository_storage_types.html documents the change, but not how to translate.

Rails can do it and some rails console commands should be a good MVC for users. Update based on this comment

There's other similar issues as well, such as providing it via the API.

2: rails console / debugging

I found that I could not find a single source of truth for running the rails console, so I added one so I could refer to it.

While linking that back within the same document, I also removed some console prompt output from sample commands. IMO, it's fine to include prompts from consoles on output, and it can often make it clearer

When providing commands to run, including the prompts requires the reader to be able to identify which part is the prompt, and which is the command. A lot of self-hosted instances are supported by folk who are not rails developers.

Related issues

Author's checklist

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

  • Optional: 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 🤖 GitLab Bot 🤖

Merge request reports