CTRT: Refactor Registering runners page
Problem to solve
The Registering runners page needs to be adapted to include the registration instructions for the new registration process (runner authentication tokens) and the legacy registration process (runner registration tokens), and to clarify the token requirement in the prerequisites section.
- For registration with authentication tokens:
- Users create a runner in the UI or with the API to obtain the token that they use to register the runner.
- The runner authentication token is stored in the
config.toml
. - The
gitlab-runner register
command no longer accepts the arguments for tags, maintenance notes, and description.
- For registration with registration tokens:
- Users copy/paste the registration token from the runners page.
- The
gitlab-runner register
command accepts tags, maintenance notes, and description.
Further details
FY24Q3 TW OKR: Refactor high visibility pages f... (technical-writing#839 - closed)
Proposal
As part of the CTRT OKR, restructure the page to include instructions for:
- Registering runners with the authentication token and registration token.
- One approach could be using tabs for each operating system...
💡
- One approach could be using tabs for each operating system...
- Refactor Manage runners to update the language around obtaining the registration token. The docs currently say 'create runner', but 'creating runners' is more of a feature for the new runner registration process.
Who can address the issue
TW for grouprunner
Other links/references
Edited by Fiona Neill