Merge branch 'master' into che-20820-both

.github/workflows/build-and-validate-on-pr.yaml

@@ -67,9 +67,12 @@ jobs:
         id: validate-links
         run: htmltest
 
-      - name: Report Unused Images
+      - name: Report unused images
         run: tools/detect-unused-images.sh
 
+      - name: Report unused partials
+        run: tools/detect-unused-partials.sh
+
       - name: Validate language on files added or modified
         run: |
           tools/get_vale_styles.sh

.vale.ini

@@ -8,7 +8,8 @@ StylesPath = .vale/styles
 # -------------------
 # The minimum alert level in the output (suggestion, warning, or error).
 # If integrated into CI, builds fail by default on error-level alerts, unless you run Vale with the --no-exit flag
-MinAlertLevel = suggestion
+; MinAlertLevel = suggestion
+MinAlertLevel = warning
 
 # IgnoredScopes specifies inline-level HTML tags to ignore.
 # These tags may occur in an active scope (unlike SkippedScopes, skipped entirely) but their content still will not raise any alerts.

antora.yml

@@ -11,7 +11,6 @@ nav:
   - modules/end-user-guide/nav.adoc
   - modules/installation-guide/nav.adoc
   - modules/administration-guide/nav.adoc
-  - modules/contributor-guide/nav.adoc
   - modules/extensions/nav.adoc
   - modules/glossary/nav.adoc
 asciidoc:

gulpfile.js

@@ -32,7 +32,7 @@ function generate(done) {
 async function serve(done) {
   connect.server(serverConfig, function () {
     this.server.on('close', done)
-    watch(watchPatterns, series(generate, testlang, testhtml))
+    watch(watchPatterns, series(generate, testlang, testhtml, testimages, testpartials))
     if (livereload) watch(this.root).on('change', (filepath) => src(filepath, { read: false }).pipe(livereload()))
   })
 }
@@ -55,12 +55,10 @@ async function environment_docs_gen() {
   // Report script errors but don't make gulp fail.
   try {
     const { stdout, stderr } = await exec('tools/environment_docs_gen.sh')
-    console.log(stdout);
-    console.error(stderr);
+    console.log(stdout, stderr);
   }
   catch (error) {
-    console.log(error.stdout);
-    console.log(error.stderr);
+    console.log(error.stdout, error.stderr);
     return;
   }
 }
@@ -69,12 +67,10 @@ async function testhtml() {
   // Report links errors but don't make gulp fail.
   try {
     const { stdout, stderr } = await exec('htmltest')
-    console.log(stdout);
-    console.error(stderr);
+    console.log(stdout, stderr);
   }
   catch (error) {
-    console.log(error.stdout);
-    console.log(error.stderr);
+    console.log(error.stdout, error.stderr);
     return;
   }
 }
@@ -83,19 +79,42 @@ async function testlang() {
   // Report language errors but don't make gulp fail.
   try {
     const { stdout, stderr } = await exec('./tools/validate_language_changes.sh')
-    console.log(stdout);
-    console.error(stderr);
+    console.log(stdout, stderr);
   }
   catch (error) {
-    console.log(error.stdout);
-    console.log(error.stderr);
+    console.log(error.stdout, error.stderr);
     return;
   }
 }
 
+async function testimages() {
+  // Report unused images but don't make gulp fail.
+  try {
+    const { stdout, stderr } = await exec('./tools/detect-unused-images.sh')
+    console.log(stdout, stderr);
+  }
+  catch (error) {
+    console.log(error.stdout, error.stderr);
+    return;
+  }
+}
+
+async function testpartials() {
+  // Report unused partials but don't make gulp fail.
+  try {
+    const { stdout, stderr } = await exec('./tools/detect-unused-partials.sh')
+    console.log(stdout, stderr);
+  }
+  catch (error) {
+    console.log(error.stdout, error.stderr);
+    return;
+  }
+}
+
+
 exports.default = series(
   parallel(checluster_docs_gen, environment_docs_gen),
   generate,
   serve,
-  parallel(testlang, testhtml)
+  parallel(testlang, testhtml, testimages, testpartials)
 );

modules/administration-guide/nav.adoc

@@ -1,10 +1,6 @@
 .Administration Guide
 
 * xref:architecture-overview.adoc[]
-** xref:architecture-overview-with-che-server.adoc[]
-*** xref:server-components-with-che-server.adoc[]
-*** xref:che-workspaces-architecture-with-che-server.adoc[]
-** xref:architecture-overview-with-devworkspace.adoc[]
 *** xref:server-components.adoc[]
 **** xref:che-operator.adoc[]
 **** xref:devworkspace-operator.adoc[]
@@ -15,61 +11,26 @@
 **** xref:postgresql.adoc[]
 **** xref:plug-in-registry.adoc[]
 *** xref:user-workspaces.adoc[]
-
 * xref:calculating-che-resource-requirements.adoc[]
-
-* xref:customizing-the-registries.adoc[]
-** xref:building-custom-registry-images.adoc[]
-** xref:running-custom-registries.adoc[]
-
+// * xref:customizing-the-registries.adoc[] // TO REWRITE
+// ** xref:building-custom-registry-images.adoc[] // TO REWRITE
+// ** xref:running-custom-registries.adoc[] // TO REWRITE
 * xref:retrieving-che-logs.adoc[]
 ** xref:configuring-server-logging.adoc[]
-** xref:viewing-kubernetes-events.adoc[]
-** xref:viewing-operator-events.adoc[]
-** xref:viewing-che-server-logs.adoc[]
-** xref:viewing-external-service-logs.adoc[]
-** xref:viewing-plug-in-broker-logs.adoc[]
+// ** xref:viewing-operator-events.adoc[] // REWRITE
+// ** xref:viewing-che-server-logs.adoc[] // REWRITE
+// ** xref:viewing-external-service-logs.adoc[] // REWRITE
 ** xref:collecting-logs-using-chectl.adoc[]
-
 * xref:monitoring-che.adoc[]
-
 * xref:monitoring-the-dev-workspace-operator.adoc[]
-
-* xref:tracing-che.adoc[]
-
-* xref:backup-and-recovery.adoc[]
-** xref:supported-restic-compatible-backup-servers.adoc[]
-** xref:backing-up-of-che-instances-to-an-sftp-backup-server.adoc[]
-** xref:backing-up-of-che-instances-to-amazon-s3.adoc[]
-** xref:backing-up-of-che-instances-to-a-rest-backup-server.adoc[]
-** xref:backing-up-of-che-instances-to-the-internal-backup-server.adoc[]
-** xref:restoring-a-che-instance-from-a-backup.adoc[]
-** xref:backups-of-persistent-volumes.adoc[]
-** xref:backups-of-postgresql.adoc[]
-
-* xref:migration-from-postgresql-9-to-postgresql-13.adoc[]
-
-* xref:readiness-init-containers.adoc[]
-** xref:enabling-and-disabling-readiness-init-containers-for-the-operator-installer.adoc[]
-*** xref:enabling-readiness-init-containers-for-the-operator-installer.adoc[]
-*** xref:disabling-readiness-init-containers-for-the-operator-installer.adoc[]
-** xref:enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc[]
-*** xref:enabling-readiness-init-containers-for-the-olm-installer.adoc[]
-*** xref:disabling-readiness-init-containers-for-the-olm-installer.adoc[]
-
 * xref:caching-images-for-faster-workspace-start.adoc[]
 ** xref:defining-the-list-of-images-to-pull.adoc[]
 ** xref:defining-the-memory-parameters-for-the-image-puller.adoc[]
 ** xref:installing-image-puller-using-che-operator.adoc[]
 ** xref:installing-image-puller-on-kubernetes-using-the-image-puller-operator.adoc[]
 ** xref:installing-image-puller-on-openshift-using-operatorhub.adoc[]
 ** xref:installing-image-puller-on-openshift-using-openshift-templates.adoc[]
-
 * xref:managing-identities-and-authorizations.adoc[]
-** xref:authenticating-users.adoc[]
-** xref:authorizing-users.adoc[]
-** xref:configuring-authorization.adoc[]
-*** xref:configuring-openshift-oauth.adoc[]
-*** xref:configuring-minikube-github-authentication.adoc[]
-
 ** xref:removing-user-data.adoc[]
+
+* xref:branding-che-theia.adoc[]

modules/administration-guide/pages/architecture-overview.adoc

@@ -2,6 +2,6 @@
 // = Che architecture overview
 :navtitle: Architecture overview
 :keywords: administration-guide, architecture-overview
-:page-aliases: .:che-architecture-overview, .:high-level-che-architecture, overview:high-level-che-architecture, administration-guide:high-level-che-architecture, che-architecture-overview
+: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
 
 include::partial$con_architecture-overview.adoc[]

modules/contributor-guide/pages/branding-che-theia.adoc → modules/administration-guide/pages/branding-che-theia.adoc

@@ -2,6 +2,6 @@
 // = Branding Che-Theia
 :navtitle: Branding Che-Theia
 :keywords: contributor-guide, branding-che-theia
-:page-aliases: .:branding-che-theia
+:page-aliases: contributor-guide:branding-che-theia
 
 include::partial$assembly_branding-che-theia.adoc[]

modules/administration-guide/pages/che-operator.adoc

@@ -1,6 +1,6 @@
 [id="{prod-id-short}-operator"]
 :navtitle: {prod-short} operator
 :keywords: administration-guide, architecture, operator
-// :page-aliases: 
+:page-aliases: 
 
 include::partial$con_che-operator.adoc[]

modules/administration-guide/pages/che-server.adoc

@@ -1,6 +1,6 @@
 [id="{prod-id-short}-server"]
 :navtitle: {prod-short} server
 :keywords: administration-guide, architecture, server, devworkspace
-// :page-aliases: 
+:page-aliases: 
 
 include::partial$con_che-server-with-devworkspace.adoc[]

modules/administration-guide/pages/dashboard.adoc

@@ -1,6 +1,6 @@
 [id="dashboard"]
 :navtitle: User dashboard
 :keywords: administration-guide, architecture, server, devworkspace, user, dashboard
-// :page-aliases: 
+:page-aliases: 
 
 include::partial$con_dashboard.adoc[]

modules/administration-guide/pages/devfile-registries.adoc

@@ -1,6 +1,6 @@
 [id="devfile-registries"]
 :navtitle: Devfile registries
 :keywords: administration-guide, architecture, server, devworkspace, devfile, registry
-// :page-aliases: 
+:page-aliases: 
 
 include::partial$con_devfile-registries.adoc[]