Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: normalized metadata for administration guide (present, sorted) #2427

Merged
merged 1 commit into from
Aug 25, 2022
Merged
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
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:_content-type: ASSEMBLY
:navtitle: Advanced configuration options for {prod-short} server
:description: Advanced deployment and configuration methods for the {prod-short} server component.
:keywords: administration guide, configuring, configuration, {prod-short} server
:page-aliases: installation-guide:advanced-configuration-options-for-the-che-server-component, installation-guide:configuring-system-variables
: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

:parent-context-of-advanced-configuration-options-for-the-che-server-component: {context}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:_content-type: CONCEPT
:navtitle: Architecture
:description: High-level {prod-short} architecture
:keywords: administration-guide, architecture
:page-aliases: .:che-architecture-overview, .:high-level-che-architecture, overview:high-level-che-architecture, administration-guide:high-level-che-architecture, che-architecture-overview, .:che-architecture-overview-with-che-server, .:high-level-che-architecture-with-che-server, overview:high-level-che-architecture-with-che-server, administration-guide:high-level-che-architecture-with-che-server, .:che-architecture-overview-with-devworkspace, .:high-level-che-architecture-with-devworkspace, overview:high-level-che-architecture-with-devworkspace, administration-guide:high-level-che-architecture-with-devworkspace, architecture-overview-with-devworkspace, architecture-overview-with-che-server, server-components-with-che-server, che-workspaces-architecture-with-che-server, backup-and-recovery, supported-restic-compatible-backup-servers, backing-up-of-che-instances-to-an-sftp-backup-server, backing-up-of-che-instances-to-amazon-s3, backing-up-of-che-instances-to-a-rest-backup-server, backing-up-of-che-instances-to-the-internal-backup-server, restoring-a-che-instance-from-a-backup, backups-of-persistent-volumes, backups-of-postgresql, migration-from-postgresql-9-to-postgresql-13, readiness-init-containers, enabling-and-disabling-readiness-init-containers-for-the-operator-installer, enabling-readiness-init-containers-for-the-operator-installer, disabling-readiness-init-containers-for-the-operator-installer, enabling-and-disabling-readiness-init-containers-for-the-olm-installer, enabling-readiness-init-containers-for-the-olm-installer, disabling-readiness-init-containers-for-the-olm-installer, overview:architecture-overview, overview:che-architecture
:navtitle: Architecture
:page-aliases: .:che-architecture-overview.adoc, .:high-level-che-architecture.adoc, overview:high-level-che-architecture.adoc, administration-guide:high-level-che-architecture.adoc, che-architecture-overview.adoc, .:che-architecture-overview-with-che-server.adoc, .:high-level-che-architecture-with-che-server.adoc, overview:high-level-che-architecture-with-che-server.adoc, administration-guide:high-level-che-architecture-with-che-server.adoc, .:che-architecture-overview-with-devworkspace.adoc, .:high-level-che-architecture-with-devworkspace.adoc, overview:high-level-che-architecture-with-devworkspace.adoc, administration-guide:high-level-che-architecture-with-devworkspace.adoc, architecture-overview-with-devworkspace.adoc, architecture-overview-with-che-server, server-components-with-che-server.adoc, che-workspaces-architecture-with-che-server.adoc, backup-and-recovery.adoc, supported-restic-compatible-backup-servers.adoc, backing-up-of-che-instances-to-an-sftp-backup-server.adoc, backing-up-of-che-instances-to-amazon-s3.adoc, backing-up-of-che-instances-to-a-rest-backup-server.adoc, backing-up-of-che-instances-to-the-internal-backup-server.adoc, restoring-a-che-instance-from-a-backup.adoc, backups-of-persistent-volumes.adoc, backups-of-postgresql.adoc, migration-from-postgresql-9-to-postgresql-13.adoc, readiness-init-containers.adoc, enabling-and-disabling-readiness-init-containers-for-the-operator-installer.adoc, enabling-readiness-init-containers-for-the-operator-installer.adoc, disabling-readiness-init-containers-for-the-operator-installer.adoc, enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc, enabling-readiness-init-containers-for-the-olm-installer.adoc, disabling-readiness-init-containers-for-the-olm-installer.adoc, overview:architecture-overview.adoc, overview:che-architecture.adoc

[id="architecture_{context}"]
= {prod-short} architecture
Expand Down Expand Up @@ -37,4 +37,3 @@ Controls access to all resources.
* link:https://github.com/devfile/devworkspace-operator[{devworkspace} Operator repository]

include::example$snip_che-architecture-overview-with-devworkspace-additional-resources.adoc[]

5 changes: 3 additions & 2 deletions modules/administration-guide/pages/branding-che-theia.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
:_content-type: PROCEDURE
:navtitle: Branding Che-Theia
:description: Customize the Che-Theia interface and branding
:keywords: contributor-guide, branding-che-theia
:page-aliases: contributor-guide:branding-che-theia
:navtitle: Branding Che-Theia
:page-aliases: contributor-guide:branding-che-theia.adoc

:parent-context-of-branding-che-theia: {context}

[id="branding-che-theia_{context}"]
Expand Down
6 changes: 3 additions & 3 deletions modules/administration-guide/pages/branding.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:_content-type: ASSEMBLY
:navtitle: Branding
:description: Branding the Che-Theia
:description: Branding {prod}
:keywords: administration-guide, branding
:page-aliases:
:navtitle: Branding
:page-aliases:

[id="branding_{context}"]
= Branding
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:_content-type: REFERENCE
:navtitle: Caching images for faster workspace start
:description: Caching images for faster workspace start
:keywords: administration-guide, caching-images-for-faster-workspace-start
:page-aliases: .:caching-images-for-faster-workspace-start
:navtitle: Caching images for faster workspace start
:page-aliases: .:caching-images-for-faster-workspace-start.adoc


[id="caching-images-for-faster-workspace-start_{context}"]
Expand Down Expand Up @@ -77,4 +77,3 @@ The {image-puller-name-short} provides the following parameters for configuratio
* xref:installing-image-puller-on-openshift-using-cli.adoc[]

* link:https://github.com/che-incubator/{image-puller-repository-name}[{image-puller-name} source code repository]

Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:_content-type: ASSEMBLY
:navtitle: Calculating Che resource requirements
:description: Calculating {prod-short} resource requirements
:keywords: administration-guide, calculating-che-resource-requirements
:page-aliases: .:calculating-che-resource-requirements
:navtitle: Calculating Che resource requirements
:page-aliases: .:calculating-che-resource-requirements.adoc

:parent-context-of-calculating-che-resource-requirements: {context}

Expand Down
4 changes: 2 additions & 2 deletions modules/administration-guide/pages/che-operator.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:_content-type: ASSEMBLY
:navtitle: {prod-short} operator
:description: Components of {prod-short} operator
:keywords: administration-guide, architecture, operator
:page-aliases:
:navtitle: {prod-short} operator
:page-aliases:

[id="{prod-id-short}-operator_{context}"]
= {prod-short} operator
Expand Down
5 changes: 2 additions & 3 deletions modules/administration-guide/pages/che-server.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:_content-type: ASSEMBLY
:navtitle: {prod-short} server
:description: Functions of {prod-short} server
:keywords: administration-guide, architecture, server, devworkspace
:page-aliases:
:navtitle: {prod-short} server
:page-aliases:

[id="{prod-id-short}-server-with-devworkspace_{context}"]
= {prod-short} server
Expand All @@ -28,4 +28,3 @@ image::architecture/{project-context}-server-interactions.png[{prod-short} serve
* xref:advanced-configuration-options-for-the-che-server-component.adoc[]

include::example$snip_{project-context}-che-server-additional-resources.adoc[]

Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
[id="che-theia-workspaces"]
// = Che-Theia workspaces
:_content-type: CONCEPT
:navtitle: Che-Theia workspaces
:description: Telemetry overview
:keywords: che-theia, workspaces
:page-aliases: extensions:che-theia-workspaces
:navtitle: Che-Theia workspaces
:page-aliases: extensions:che-theia-workspaces.adoc

[id="che-theia-workspaces"]
= Che-Theia workspaces

[id="telemetry-overview_{context}"]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:_content-type: ASSEMBLY
:navtitle: `CheCluster` Custom Resource fields reference
:description: `CheCluster` Custom Resource fields reference
:keywords: administration guide, checluster, custom resource
:page-aliases: installation-guide:checluster-custom-resource-fields-reference
:navtitle: `CheCluster` Custom Resource fields reference
:page-aliases: installation-guide:checluster-custom-resource-fields-reference.adoc

[id="checluster-custom-resources-fields-reference_{context}"]
= `CheCluster` Custom Resource fields reference
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:_content-type: REFERENCE
:navtitle: Collecting logs using {prod-cli}
:description: Collecting logs using {prod-cli}
:keywords: administration-guide, collecting-logs-using-chectl
:page-aliases: .:collecting-logs-using-chectl
:navtitle: Collecting logs using {prod-cli}
:page-aliases: .:collecting-logs-using-chectl.adoc

[id="collecting-logs-using-{prod-cli}_{context}"]
= Collecting logs using {prod-cli}
Expand Down Expand Up @@ -39,4 +39,3 @@ Logs are automatically collected during the {prod-short} installation when insta
.Additional resources

* {link-prod-cli-documentation}

Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:_content-type: PROCEDURE
:navtitle: Configuring {prod-short} hostname
:description: Configuring {prod-short} to use custom hostname
:keywords: administration guide, configuring, {prod}, {prod-short}, hostname
:page-aliases: installation-guide:configuring-che-hostname
:navtitle: Configuring {prod-short} hostname
:page-aliases: installation-guide:configuring-che-hostname.adoc

[id="configuring-{prod-id-short}-server-hostname_{context}"]
= Configuring {prod} server hostname
Expand Down Expand Up @@ -69,4 +69,3 @@ spec:
* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]

* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]

5 changes: 2 additions & 3 deletions modules/administration-guide/pages/configuring-che.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
:_content-type: ASSEMBLY
:navtitle: Configuring {prod-short}
:description: Configuring methods for {prod-short}
:keywords: administration guide, configuring, configuration
:page-aliases: installation-guide:configuring-che, installation-guide:advanced-configuration, installation-guide:advanced-configuration-options, installation-guide:setting-up-the-keycloak-che-username-readonly-theme-for-the-eclipse-che-login-page, installation-guide:configuring-communication-between-che-components, installation-guide:configuring-storage-strategies, installation-guide:configuring-storage-types, installation-guide:configuring-the-number-of-workspaces-that-a-user-can-run, installation-guide:configuring-workspace-exposure-strategies, installation-guide:enabling-dev-workspace-operator, running-custom-registries, building-custom-registry-images, customizing-the-registries, advanced-configuration
:navtitle: Configuring {prod-short}
:page-aliases: installation-guide:configuring-che.adoc, installation-guide:advanced-configuration.adoc, installation-guide:advanced-configuration-options.adoc, installation-guide:setting-up-the-keycloak-che-username-readonly-theme-for-the-eclipse-che-login-page.adoc, installation-guide:configuring-communication-between-che-components.adoc, installation-guide:configuring-storage-strategies.adoc, installation-guide:configuring-storage-types.adoc, installation-guide:configuring-the-number-of-workspaces-that-a-user-can-run.adoc, installation-guide:configuring-workspace-exposure-strategies.adoc, installation-guide:enabling-dev-workspace-operator.adoc, running-custom-registries.adoc, building-custom-registry-images.adoc, customizing-the-registries.adoc, advanced-configuration.adoc

[id="configuring-che_{context}"]
= Configuring {prod-short}

This section describes configuration methods and options for {prod}.

Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:_content-type: PROCEDURE
:navtitle: Configuring {orch-ingress}
:description: Configuring labels and annotations on each {orch-ingress}
:keywords: administration guide, configuring, ingress, ingresses
:page-aliases: installation-guide:configuring-ingresses
:navtitle: Configuring {orch-ingress}
:page-aliases: installation-guide:configuring-ingresses.adoc

[id="adding-labels-and-annotations-to-ingresses_{context}"]
= Adding labels and annotations to {orch-ingress}
Expand Down Expand Up @@ -39,4 +39,3 @@ spec:
* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]

* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]

Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:_content-type: CONCEPT
:navtitle: Configuring {orch-namespace}s
:description: Configuring user {orch-namespace} provisioning
:keywords: administration guide, configuring, namespace
:page-aliases: installation-guide:configuring-namespace-strategies, configuring-namespace-strategies
:navtitle: Configuring {orch-namespace}s
:page-aliases: installation-guide:configuring-namespace-strategies.adoc, configuring-namespace-strategies.adoc

[id="configuring-user-{orch-namespace}-provisioning_{context}"]
= Configuring user {orch-namespace} provisioning
Expand All @@ -15,4 +15,3 @@ You can modify {prod-short} behavior by:

* xref:configuring-workspace-target-namespace.adoc[]
* xref:provisioning-namespaces-in-advance.adoc[]

Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:_content-type: ASSEMBLY
:navtitle: Configuring networking
:description: Configuring networking
:keywords: administration-guide, configuring, networking
:page-aliases:
:navtitle: Configuring networking
:page-aliases:

[id="configuring-networking_{context}"]
= Configuring networking
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Configuring OAuth 1.0 for Bitbucket
:keywords: configuring-oauth, authorization, bitbucket, oauth-1, oauth-1.0
:navtitle: Configuring OAuth 1.0 for Bitbucket
// :page-aliases:
:page-aliases:

[id="configuring-oauth-1-for-bitbucket_{context}"]
= Configuring OAuth 1.0 for Bitbucket
Expand All @@ -14,4 +14,4 @@ To enable users to work with a remote Git repository that is hosted on a Bitbuck

include::partial$proc_setting-up-the-bitbucket-application-link.adoc[leveloffset=+1]

include::partial$proc_applying-the-bitbucket-application-link-secret.adoc[leveloffset=+1]
include::partial$proc_applying-the-bitbucket-application-link-secret.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Configuring OAuth 2.0 for GitHub
:keywords: configuring-oauth, authorization, github, oauth-2, oauth-2.0
:navtitle: Configuring OAuth 2.0 for GitHub
// :page-aliases:
:page-aliases:

[id="configuring-oauth-2-for-github_{context}"]
= Configuring OAuth 2.0 for GitHub
Expand All @@ -14,4 +14,4 @@ To enable users to work with a remote Git repository that is hosted on GitHub:

include::partial$proc_setting-up-the-github-oauth-app.adoc[leveloffset=+1]

include::partial$proc_applying-the-github-oauth-app-secret.adoc[leveloffset=+1]
include::partial$proc_applying-the-github-oauth-app-secret.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Configuring OAuth 2.0 for GitLab
:keywords: configuring-oauth, authorization, gitlab, oauth-2, oauth-2.0
:navtitle: Configuring OAuth 2.0 for GitLab
// :page-aliases:
:page-aliases:

[id="configuring-oauth-2-for-gitlab_{context}"]
= Configuring OAuth 2.0 for GitLab
Expand All @@ -14,4 +14,4 @@ To enable users to work with a remote Git repository that is hosted using a GitL

include::partial$proc_setting-up-the-gitlab-authorized-application.adoc[leveloffset=+1]

include::partial$proc_applying-the-gitlab-authorized-application-secret.adoc[leveloffset=+1]
include::partial$proc_applying-the-gitlab-authorized-application-secret.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:_content-type: ASSEMBLY
:navtitle: Configuring observability
:description: Configuring observability
:keywords: administration-guide, configuring, observability, logs, monitoring
:page-aliases: .:retrieving-che-logs, .:viewing-kubernetes-events, viewing-kubernetes-events, .:viewing-plug-in-broker-logs, viewing-plug-in-broker-logs, retrieving-che-logs, viewing-che-server-logs, viewing-external-service-logs,
:navtitle: Configuring observability
:page-aliases: .:retrieving-che-logs.adoc, .:viewing-kubernetes-events.adoc, viewing-kubernetes-events.adoc, .:viewing-plug-in-broker-logs.adoc, viewing-plug-in-broker-logs.adoc, retrieving-che-logs.adoc, viewing-che-server-logs.adoc, viewing-external-service-logs.adoc

[id="configuring-observability_{context}"]
= Configuring observability
Expand Down
4 changes: 2 additions & 2 deletions modules/administration-guide/pages/configuring-routes.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:_content-type: PROCEDURE
:navtitle: Configuring OpenShift Route
:description: Configuring OpenShift Route
:keywords: administration guide, configuring, routes
:page-aliases: installation-guide:configuring-routes
:navtitle: Configuring OpenShift Route
:page-aliases: installation-guide:configuring-routes.adoc

[id="configuring-routes_{context}"]
= Configuring OpenShift Route to work with Router Sharding
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:_content-type: ASSEMBLY
:navtitle: Configuring server components
:description: Configuring server components
:keywords: administration-guide, configuring, server components
:page-aliases:
:navtitle: Configuring server components
:page-aliases:

[id="configuring-server-components_{context}"]
= Configuring server components
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:_content-type: ASSEMBLY
:navtitle: Configuring server logging
:description: Configuring server logging
:keywords: administration-guide, configuring-server-logging
:page-aliases: .:configuring-server-logging
:navtitle: Configuring server logging
:page-aliases: .:configuring-server-logging.adoc

[id="configuring-sever-logging_{context}"]
= Configuring server logging
Expand Down
4 changes: 2 additions & 2 deletions modules/administration-guide/pages/configuring-storage.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:_content-type: ASSEMBLY
:navtitle: Configuring storage
:description: Configuring storage
:keywords: administration-guide, configuring, storage
:page-aliases:
:navtitle: Configuring storage
:page-aliases:

[id="configuring-storage_{context}"]
= Configuring storage
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
:_content-type: PROCEDURE
:navtitle: Configuring the administrative user
:description: To execute actions that require administrative privileges on {prod-short} server, such as deleting user data, activate a user with administrative privileges.
:keywords: administration-guide, admin
:navtitle: Configuring the administrative user
:page-aliases:

[id="configuring-the-administrative-user_{context}"]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:_content-type: PROCEDURE
:navtitle: Configuring {orch-namespace} name
:description: Configuring a user {orch-namespace} name for automatic provisioning
:keywords: administration guide, configuring, namespace
:page-aliases:
:navtitle: Configuring {orch-namespace} name
:page-aliases:

[id="configuring-a-user-{orch-namespace}-name-for-automatic-provisioning_{context}"]
= Configuring a user {orch-namespace} name for automatic provisioning
Expand Down Expand Up @@ -59,4 +59,3 @@ spec:
* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]

* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]

Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:_content-type: ASSEMBLY
:navtitle: Configuring workspaces globally
:description: Configuring workspaces globally
:keywords: administration-guide, configuring, workspaces
:page-aliases:
:navtitle: Configuring workspaces globally
:page-aliases:

[id="configuring-workspaces-globally_{context}"]
= Configuring workspaces globally
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:_content-type: PROCEDURE
:navtitle: Configuring workspaces nodeSelector
:description: Configuring workspaces nodeSelector
:keywords: administration guide, configuring-workspaces-nodeselector
:page-aliases: installation-guide:configuring-workspaces-nodeselector
:navtitle: Configuring workspaces nodeSelector
:page-aliases: installation-guide:configuring-workspaces-nodeselector.adoc

[id="configuring-workspaces-nodeselector"]
= Configuring workspaces nodeSelector
Expand Down Expand Up @@ -31,4 +31,3 @@ Pass the name of this newly created `StorageClass` to {prod-short} through the `
* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]

* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]

Loading