Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ nav:
- modules/secure/nav.adoc
- modules/optimize/nav.adoc
- modules/observe/nav.adoc
- modules/configure/nav.adoc
- modules/administration-guide/nav.adoc
- modules/extensions/nav.adoc
- modules/glossary/nav.adoc
Expand Down
72 changes: 15 additions & 57 deletions modules/administration-guide/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,61 +1,20 @@
.Administration Guide

* xref:configuring-che.adoc[]
** xref:understanding-the-checluster-custom-resource.adoc[]
*** xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
*** xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
*** xref:checluster-custom-resource-fields-reference.adoc[]
** xref:configuring-namespace-provisioning.adoc[]
*** xref:configuring-workspace-target-namespace.adoc[]
*** xref:provisioning-namespaces-in-advance.adoc[]
*** xref:configuring-a-user-namespace.adoc[]
*** xref:configuring-kubernetes-namespace-creation-on-openshift.adoc[]
** xref:configuring-server-components.adoc[]
*** xref:advanced-configuration-options-for-the-che-server-component.adoc[]
** xref:configuring-workspaces-globally.adoc[]
*** xref:limiting-the-number-of-workspaces-that-a-user-can-keep.adoc[]
*** xref:limiting-the-number-of-workspaces-that-all-users-can-run-simultaneously.adoc[]
*** xref:enabling-users-to-run-multiple-workspaces-simultaneously.adoc[]
*** xref:deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc[]
*** xref:configuring-workspaces-nodeselector.adoc[]
*** xref:configuring-allowed-urls-for-cloud-development-environments.adoc[]
*** xref:enabling-container-run-capabilities.adoc[]
** xref:configuring-networking.adoc[]
*** xref:configuring-network-policies.adoc[]
*** xref:configuring-che-hostname.adoc[]
*** xref:configuring-che-with-self-signed-certificate.adoc[]
*** xref:importing-untrusted-tls-certificates.adoc[]
*** xref:adding-labels-and-annotations.adoc[]
*** xref:configuring-workspaces-endpoints-base-domain.adoc[]
*** xref:configuring-proxy.adoc[]
** xref:configuring-storage.adoc[]
*** xref:configuring-storage-classes.adoc[]
*** xref:configuring-the-storage-strategy.adoc[]
*** xref:configuring-storage-sizes.adoc[]
*** xref:con_persistent-user-home.adoc[]
** xref:configuring-dashboard.adoc[]
*** xref:configuring-getting-started-samples.adoc[]
*** xref:configuring-editors-definitions.adoc[]
*** xref:show-deprecated-editors.adoc[]
*** xref:configuring-default-editor.adoc[]
*** xref:concealing-editors.adoc[]
*** xref:configuring-editors-download-urls.adoc[]
*** xref:configuring-ai-providers.adoc[]
**** xref:ai-provider-api-key-secret-reference.adoc[]
*** xref:customizing-openshift-che-branding-images.adoc[]
** xref:configuring-oauth-for-git-providers.adoc[]
*** xref:configuring-oauth-2-for-github.adoc[]
*** xref:configuring-oauth-2-for-gitlab.adoc[]
*** xref:configuring-oauth-2-for-a-bitbucket-server.adoc[]
*** xref:configuring-oauth-2-for-the-bitbucket-cloud.adoc[]
*** xref:configuring-oauth-1-for-a-bitbucket-server.adoc[]
*** xref:configuring-oauth-2-for-microsoft-azure-devops-services.adoc[]
** xref:configuring-fuse.adoc[]
*** xref:enabling-access-to-dev-fuse-for-openshift.adoc[]
*** xref:enabling-fuse-for-all-workspaces.adoc[]
** xref:devworkspace-backup.adoc[]
*** xref:devworkspace-backup-integrated-openshift-registry.adoc[]
*** xref:devworkspace-backup-regular-oci-registry.adoc[]
* Editors and AI providers
** xref:configuring-editors-definitions.adoc[]
** xref:show-deprecated-editors.adoc[]
** xref:configuring-default-editor.adoc[]
** xref:concealing-editors.adoc[]
** xref:configuring-editors-download-urls.adoc[]
** xref:configuring-ai-providers.adoc[]
*** xref:ai-provider-api-key-secret-reference.adoc[]
* xref:configuring-oauth-for-git-providers.adoc[]
** xref:configuring-oauth-2-for-github.adoc[]
** xref:configuring-oauth-2-for-gitlab.adoc[]
** xref:configuring-oauth-2-for-a-bitbucket-server.adoc[]
** xref:configuring-oauth-2-for-the-bitbucket-cloud.adoc[]
** xref:configuring-oauth-1-for-a-bitbucket-server.adoc[]
** xref:configuring-oauth-2-for-microsoft-azure-devops-services.adoc[]
* xref:managing-ide-extensions.adoc[]
** xref:extensions-for-microsoft-visual-studio-code-open-source.adoc[]
** xref:configuring-the-open-vsx-registry-url.adoc[]
Expand All @@ -71,4 +30,3 @@
** xref:default-extensions-for-microsoft-visual-studio-code.adoc[]
** xref:manage-extension-installation.adoc[]
** xref:editor-configurations-for-microsoft-visual-studio-code.adoc[]
* xref:managing-workloads-using-the-che-server-api.adoc[]
47 changes: 47 additions & 0 deletions modules/configure/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
.Configure
* Configure the platform
** xref:configuring-che.adoc[]
*** xref:understanding-the-checluster-custom-resource.adoc[]
**** xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
**** xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
**** xref:checluster-custom-resource-fields-reference.adoc[]
** xref:configuring-server-components.adoc[]
*** xref:advanced-configuration-options-for-the-che-server-component.adoc[]
** xref:configuring-dashboard.adoc[]
*** xref:configuring-getting-started-samples.adoc[]
*** xref:customizing-openshift-che-branding-images.adoc[]
** xref:managing-workloads-using-the-che-server-api.adoc[]
* Configure workspaces
** xref:configuring-namespace-provisioning.adoc[]
*** xref:configuring-workspace-target-namespace.adoc[]
*** xref:provisioning-namespaces-in-advance.adoc[]
*** xref:configuring-a-user-namespace.adoc[]
*** xref:configuring-kubernetes-namespace-creation-on-openshift.adoc[]
** xref:configuring-workspaces-globally.adoc[]
*** xref:limiting-the-number-of-workspaces-that-a-user-can-keep.adoc[]
*** xref:limiting-the-number-of-workspaces-that-all-users-can-run-simultaneously.adoc[]
*** xref:enabling-users-to-run-multiple-workspaces-simultaneously.adoc[]
*** xref:deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc[]
*** xref:configuring-workspaces-nodeselector.adoc[]
*** xref:configuring-allowed-urls-for-cloud-development-environments.adoc[]
*** xref:enabling-container-run-capabilities.adoc[]
* Configure networking and storage
** xref:configuring-networking.adoc[]
*** xref:configuring-network-policies.adoc[]
*** xref:configuring-che-hostname.adoc[]
*** xref:configuring-che-with-self-signed-certificate.adoc[]
*** xref:importing-untrusted-tls-certificates.adoc[]
*** xref:adding-labels-and-annotations.adoc[]
*** xref:configuring-workspaces-endpoints-base-domain.adoc[]
*** xref:configuring-proxy.adoc[]
** xref:configuring-storage.adoc[]
*** xref:configuring-storage-classes.adoc[]
*** xref:configuring-the-storage-strategy.adoc[]
*** xref:configuring-storage-sizes.adoc[]
*** xref:con_persistent-user-home.adoc[]
** xref:configuring-fuse.adoc[]
*** xref:enabling-access-to-dev-fuse-for-openshift.adoc[]
*** xref:enabling-fuse-for-all-workspaces.adoc[]
** xref:devworkspace-backup.adoc[]
*** xref:devworkspace-backup-integrated-openshift-registry.adoc[]
*** xref:devworkspace-backup-regular-oci-registry.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Advanced deployment and configuration methods for the {prod-short} server component.
:keywords: administration guide, configuring, configuration, {prod-short} server
:navtitle: Advanced configuration options for {prod-short} server
:page-aliases: installation-guide:advanced-configuration-options-for-the-che-server-component.adoc, installation-guide:configuring-system-variables.adoc
:page-aliases: installation-guide:advanced-configuration-options-for-the-che-server-component.adoc, installation-guide:configuring-system-variables.adoc, administration-guide:advanced-configuration-options-for-the-che-server-component.adoc


[id="advanced-configuration-options-for-the-{prod-id-short}-server-component"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: `CheCluster` Custom Resource fields reference
:keywords: administration guide, checluster, custom resource
:navtitle: `CheCluster` Custom Resource fields reference
:page-aliases: installation-guide:checluster-custom-resource-fields-reference.adoc
:page-aliases: installation-guide:checluster-custom-resource-fields-reference.adoc, administration-guide:checluster-custom-resource-fields-reference.adoc

[id="checluster-custom-resources-fields-reference"]
= `CheCluster` Custom Resource fields reference
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Configuring a user namespace
:keywords: administration guide, configuring, user, namespace
:navtitle: Configuring a user namespace
:page-aliases:
:page-aliases: administration-guide:configuring-a-user-namespace.adoc

[id="configuring-a-user-namespace"]
= Configuring a user namespace
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
:page-aliases: administration-guide:configuring-allowed-urls-for-cloud-development-environments.adoc
:_content-type: PROCEDURE
:description: Configuring allowed URLs for Cloud Development Environments
:keywords: administration guide, configuring-allowed-sources
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Configuring {prod-short} with self-signed certificates
:keywords: administration guide, configuring, {prod}, {prod-short}, self-signed, certificate
:navtitle: Configuring {prod-short} with self-signed certificates
:page-aliases: installation-guide:configuring-che-with-self-signed-certificate.adoc
:page-aliases: installation-guide:configuring-che-with-self-signed-certificate.adoc, administration-guide:configuring-che-with-self-signed-certificate.adoc

[id="configuring-{prod-id-short}-with-self-signed-certificate"]
= Configuring {prod} with self-signed certificate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Configuring dashboard
:keywords: administration-guide, configuring, dashboard
:navtitle: Configuring dashboard
:page-aliases:
:page-aliases: administration-guide:configuring-dashboard.adoc

[id="configuring-dashboard"]
= Configuring dashboard
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Configuring fuse for workspaces
:keywords: administration-guide, configuring-fuse
:navtitle: Configuring fuse-overlayfs
:page-aliases:
:page-aliases: administration-guide:configuring-fuse.adoc

[id="configuring-fuse-overlayfs"]
= Configuring fuse-overlayfs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Configuring user {orch-namespace} provisioning
:keywords: administration guide, configuring, namespace
:navtitle: Configuring {orch-namespace}s
:page-aliases: installation-guide:configuring-namespace-strategies.adoc, configuring-namespace-strategies.adoc
:page-aliases: installation-guide:configuring-namespace-strategies.adoc, configuring-namespace-strategies.adoc, administration-guide:configuring-namespace-provisioning.adoc

[id="configuring-user-{orch-namespace}-provisioning"]
= Configuring user {orch-namespace} provisioning
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Configuring network policies
:keywords: administration guide, configuring, namespace, network policy, network policies, multitenant isolation, openshift
:navtitle: Configure network policies
:page-aliases: installation-guide:configuring-network-policies.adoc
:page-aliases: installation-guide:configuring-network-policies.adoc, administration-guide:configuring-network-policies.adoc

[id="configuring-network-policies"]
= Configure network policies
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Configuring workspaces globally
:keywords: administration-guide, configuring, workspaces
:navtitle: Configuring workspaces globally
:page-aliases:
:page-aliases: administration-guide:configuring-workspaces-globally.adoc

[id="configuring-workspaces-globally"]
= Configuring workspaces globally
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: DevWorkspace backup
:keywords: backup, storage
:navtitle: DevWorkspace backup
//:page-aliases:
:page-aliases: administration-guide:devworkspace-backup.adoc

[id="devworkspace-backup"]
= Workspace backup for {prod}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Managing {prod-short} server and {prod-short} dashboard workloads using the API
:keywords: administration-guide, api
:navtitle: Using the {prod-short} server API
:page-aliases:
:page-aliases: administration-guide:managing-workloads-using-the-che-server-api.adoc

[id="managing-workloads-using-the-{prod-id-short}-server-api"]
= Managing {prod-short} server and {prod-short} dashboard workloads using the API
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Provisioning {orch-namespace}s in advance
:keywords: administration guide, provisioning, {orch-namespace}
:navtitle: Provisioning {orch-namespace}s in advance
:page-aliases:
:page-aliases: administration-guide:provisioning-namespaces-in-advance.adoc

[id="preprovisioning-{orch-namespace}s"]
= Provisioning {orch-namespace}s in advance
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Understanding the `CheCluster` Custom Resource
:keywords: administration guide, understanding-the-checluster-custom-resource, configuring-che
:navtitle: Understanding the `CheCluster` Custom Resource
:page-aliases: installation-guide:understanding-the-checluster-custom-resource.adoc, installation-guide:configuring-the-che-installation.adoc
:page-aliases: installation-guide:understanding-the-checluster-custom-resource.adoc, installation-guide:configuring-the-che-installation.adoc, administration-guide:understanding-the-checluster-custom-resource.adoc

[id="understanding-the-checluster-custom-resource"]
= Understanding the `CheCluster` Custom Resource
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Using the CLI to configure the CheCluster Custom Resource
:keywords: administration guide
:navtitle: Using the CLI to configure the CheCluster Custom Resource
:page-aliases: installation-guide:using-the-cli-to-configure-the-checluster-custom-resource.adoc, installation-guide:using-cli-to-configure-the-checluster-custom-resource.adoc
:page-aliases: installation-guide:using-the-cli-to-configure-the-checluster-custom-resource.adoc, installation-guide:using-cli-to-configure-the-checluster-custom-resource.adoc, administration-guide:using-the-cli-to-configure-the-checluster-custom-resource.adoc

[id="using-the-cli-to-configure-the-checluster-custom-resource"]
= Using the CLI to configure the CheCluster Custom Resource
Expand Down
Loading