Move docs from cluster-integration repository
Problem to solve
From talking with @ash2k, it's time to start moving items from https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent/-/blob/master/doc into ~"devops::configure" documentation.
cc to @nagyv-gitlab and @nicholasklick for awareness.
Further details
Proposal
From gitlab-org/cluster-integration/gitlab-agent#58 (closed) …
- Let's start by creating
doc/development/agent/index.md
- we can title itKubernetes Agent development
. - There are several pages in https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent/-/tree/master/doc to move. Starting from a subfolder (
doc/development/agent/
) gives us more freedom to use short, friendly filenames --doc/development
has lots of files already.
Mikhail suggested the following moves, in order of importance:
-
User-facing, in order of importance:
-
configuration_repository.md
!48282 (merged) -
installation.md
. This needs to be unified with existing installation instructions.
-
-
Developer, in order of importance:
-
architecture.md
!48268 (merged) -
developing.md
!48509 (merged) -
identity_and_auth.md
!48514 (merged) -
gitops.md
!49262 (merged) -
kas_request_routing.md
!49282 (merged) faq.md
-
user_stories.md
!49283 (merged)
-
Extra note from Mikhail:
kas_config_example.yaml
is agitlab-kas
configuration example. It cannot be moved because there is a test to for, ensuring it's up to date. Perhaps we should just refer to it somewhere in the user docs? This is a configuration example that would be interesting for someone who is installing GitLab and Kubernetes Agent Server as part of it. It's not useful to a typical end user who installs just the Agent into their Kubernetes cluster. But it's still a piece of user-facing documentation.
Who can address the issue
Me!
Other links/references
Related to gitlab-org/cluster-integration/gitlab-agent#58 (closed)