Files
docs/runner-sidebars.js
T
silverwind be6aefc7e8 Simplify the runner docs and fix their outdated facts (#600)
The runner pages had drifted from the runner. They claimed Podman is unsupported, a registration retry limit of 10, a `container.env` proxy override that has no effect, and they used the deprecated `generate-config` command, while the actual instructions were buried under implementation details.

The develop and 5.x pages are rewritten from the current runner sources (`main` is `v5.2.0`). They are shorter and aimed at operators, with a new page covering what jobs get. The reference generator now documents the `config` command, and the quickstart pages in every language use the `gitea-runner` binary name.

Reviewed-on: https://gitea.com/gitea/docs/pulls/600
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: silverwind <[email protected]>
2026-10-21 05:25:45 +00:00

47 lines
931 B
JavaScript

// Sidebar of the runner documentation (develop version).
// Released versions carry their own copy in
// runner-docs_versioned_sidebars/version-<version>-sidebars.json.
module.exports = {
runner: [
{
type: 'doc',
id: 'index',
label: 'What is the Gitea Runner?',
},
{
type: 'category',
label: 'Installation',
collapsed: false,
items: [
'installation/binary',
'installation/docker',
'installation/kubernetes',
],
},
'registration',
'configuration',
'labels',
'jobs',
'cache',
'proxy',
{
type: 'category',
label: 'Hooks',
items: [
'hooks/job-hooks',
'hooks/post-task-script',
],
},
'monitoring',
'upgrade',
{
type: 'category',
label: 'Reference',
items: [
'reference/cli',
'reference/config-example',
],
},
],
};