Docs: Consolidate 'Generate runner tokens' page into the 'Scope of runners' page
Problem to solve
This issue plans the consolidation of the Generate runner tokens page into the Scope of runners page:
- 'Scope of runners' already provides info on the creation, registration, and management of runners in the UI, in addition to contextual info about what each runner is used for.
- 'Generate runner tokens' repeats some information about creating and registering runners with registration tokens that is already in the 'Scope of runners' page, albeit under slightly different headings.
- The typical nomenclature is that users create runners before they can register them with a token, so this issue iterates on the language in the sections of 'Generate user tokens'.
- With less pages, we improve the docs site's search capabilities.
Proposal
-
Merge content from 'Generate runner tokens' into 'Scope of runnners': -
Update headings of runner creation sections in 'Scope of runners' to differentiate between token method (WIP):
## Create a shared runner with an authentication token ## Create a shared runner with a registration token (deprecated) ## Create a project runner with and authentication token ## Create a project runner with a registration token (deprecated) ## Create a group runner with an authentication token ## Create a group runner with a registration token (deprecated)
-
-
Add deprecation warnings to existing content about registration tokens. -
Add redirect from 'Generate runner tokens' to 'Scope of runners'. -
Remove 'Generate runner tokens' from global nav.
Who can address the issue
Other links/references
Edited by Fiona Neill