Uploaded image for project: 'Red Hat OpenShift Dev Spaces (formerly CodeReady Workspaces) '
  1. Red Hat OpenShift Dev Spaces (formerly CodeReady Workspaces)
  2. CRW-10063

Restructure procedure files for DITA task compliance (ERROR + WARNING)

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done
    • Icon: Major Major
    • None
    • None
    • docs
    • None

      Files: ~20 unique (significant overlap across sub-issues)

      Covers four related Vale rules that all relate to how procedure (task) files are structured:

      5a. Remove section headings from procedure files (ERROR — 7 files, 14 instances) Procedure files must not contain ==/=== section headings. Use block titles or split into separate topics.

      File Lines
      proc_configuring-editors-definitions.adoc 179
      proc_configuring-open-vsx-registry-url.adoc 10
      proc_configuring-server-logging.adoc 14, 48, 52
      proc_enabling-access-to-dev-fuse-for-openshift.adoc 138
      proc_running-open-vsx-on-premises.adoc 9, 81, 233
      proc_creating-image-pull-secrets.adoc (user guide) 11, 37, 80
      proc_enabling-npm-artifact-repositories.adoc (user guide) 55, 68

      5b. Fix duplicate section titles (WARNING — 6 files, 14 instances) Multiple .Procedure or .Verification blocks in one file.

      File Lines
      proc_configuring-default-extensions.adoc 36, 66
      proc_configuring-server-logging.adoc 16, 42
      proc_running-open-vsx-on-premises.adoc 11, 15, 95
      proc_connecting-jetbrains-intellij-to-devspaces.adoc 35
      proc_creating-image-pull-secrets.adoc 13, 17, 41, 47
      proc_enabling-npm-artifact-repositories.adoc 15, 59

      5c. Fix non-list content after .Procedure (WARNING — 14 files) Content after .Procedure must be a single ordered list.

      File Lines
      proc_configuring-advanced-authorization.adoc 43
      proc_configuring-default-extensions.adoc 57
      proc_configuring-editors-definitions.adoc 179
      proc_configuring-storage-classes.adoc 28
      proc_configuring-storage-sizes.adoc 32
      proc_enabling-access-to-dev-fuse-for-openshift.adoc 138
      proc_installing-dev-spaces-using-web-console.adoc 27
      proc_running-open-vsx-on-premises.adoc 81
      proc_setting-up-ansible-sample.adoc 28
      proc_connecting-jetbrains-intellij-to-devspaces.adoc 45
      proc_creating-image-pull-secrets.adoc 37
      proc_enabling-npm-artifact-repositories.adoc 55
      proc_enabling-overlay-with-a-configmap.adoc 70
      proc_listing-all-workspaces.adoc 19

      5d. Fix unrecognized block titles in procedures (WARNING — 7 files, 10 instances) Only .Prerequisites, .Procedure, .Verification, .Additional resources are recognized.

      File Lines
      proc_configuring-default-extensions.adoc 31, 55, 111
      proc_configuring-proxy.adoc 56
      proc_enabling-access-to-dev-fuse-for-openshift.adoc 115
      proc_installing-dev-spaces-using-cli.adoc 34
      proc_installing-image-puller-on-openshift-using-cli.adoc 147
      proc_upgrading-dev-spaces-in-a-restricted-environment.adoc 62
      proc_connecting-jetbrains-intellij-to-devspaces.adoc 33, 49

              gtrivedi@redhat.com Gaurav Trivedi
              gtrivedi@redhat.com Gaurav Trivedi
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: