Review /debug content and move to docs
Given the latest 'docs as SSOT' standards, we should move everything into the docs and out of the hidden docs.gitlab.com/debug section. (Further background: #4 (closed) & #9 (comment 129039786)).
I am happy to move everything into https://docs.gitlab.com/ee/administration/ . By default, I will
- Move the page into /administration/troubleshooting
- Add a link under https://docs.gitlab.com/ee/administration/#troubleshooting
- Create a Support-specific page re-creating the index in /debug, so that it can be useful for Support to gather and contextualize key methods and links. Even though these are user-facing docs, it could be useful to users to see how Support frames and uses them.
Primary authors and Support managers: Is there any content that requires, before moving:
- Edits such as additional warnings & new context of 'why this doc is here' / 'who/what it's for'.
- A specific place within an existing doc on the topic, rather than moving the whole page.
File | Title | Primary Author | Notes | Status |
---|---|---|---|---|
git.md | Git tricks | @harishsr | MR | |
gitlab_rails_cheat_sheet.md | GitLab Rails Console Cheat Sheet | @harishsr | MR | |
kubernetes_cheat_sheet.md | Kubernetes, GitLab and You | @atanayno | MR | |
linux_cheat_sheet.md | Linux Cheat Sheet | @harishsr | Move into GitLab Administration. Add context: "If you are administrating GitLab you are expected to know these commands for your distro of choice. If you are a GitLab Support Engineer, consider this a cross-reference to translate yum -> apt-get and the like." Context added in !63 (merged) | MR |
resources.md | External Resources | @dstanley | MR | |
test_environments.md | Apps for a Testing Environment | @harishsr | MR | |
tools_of_trade.md | Tools of the trade | @cody | MR |
My doc is ready to move:
Signoff on the proposal:
Edited by Marcel Amirault