Uploaded image for project: 'Red Hat Internal Developer Platform'
  1. Red Hat Internal Developer Platform
  2. RHIDP-6497

Check that your procedure modules do not contain subsections

    • No level 2 titles in procedures to prepare for DITA migration
    • 13
    • False
    • Hide

      None

      Show
      None
    • False
    • 0% To Do, 0% In Progress, 100% Done

      Check that your procedure modules do not contain subsections. See [Final] CCS Deep Dive: ToolX slide 21

      This is the list of all modules that have currently a subsection:

       grep -ire '^== ' modules/ | grep -e '.adoc' |  cut -d: -f1  | sort | uniq 
      modules/about/con-benefits-of-rhdh.adoc
      modules/about/con-integrations-in-rhdh.adoc
      modules/authorization/ref-rbac-conditional-policy-definition.adoc
      modules/authorization/ref-rbac-rest-api-endpoints.adoc
      modules/configuring-a-floating-action-button/proc-configuring-floating-action-button-as-a-dynamic-plugin.adoc
      modules/customizing-the-appearance/ref-customize-rhdh-default-backstage.adoc
      modules/customizing-the-appearance/ref-customize-rhdh-default-rhdh.adoc
      modules/customizing-the-learning-paths/proc-customize-rhdh-learning-paths.adoc
      modules/customizing-the-tech-radar-page/proc-customize-rhdh-tech-radar-page.adoc
      modules/dynamic-plugins/con-ansible-plugin.adoc
      modules/dynamic-plugins/con-dynamic-plugins-cache.adoc
      modules/dynamic-plugins/con-overriding-core-backend-services.adoc
      modules/dynamic-plugins/con-rhdh-plugins.adoc
      modules/dynamic-plugins/proc-installing-and-configuring-redis-cache.adoc
      modules/dynamic-plugins/proc-topology-configure.adoc
      modules/installation/proc-install-rhdh-airgapped-environment-ocp-helm.adoc
      modules/installation/proc-rhdh-deploy-eks-operator.adoc
      modules/observe/proc-rhdh-monitoring-logging-aws.adoc
      modules/release-notes/README.adoc
      modules/release-notes/single-source-release-notes-template.adoc.jinja
      modules/using-service-now/ref-supported-servicenow-custom-actions.adoc

       

      I created subtasks for every impacted procedure.

      I did not create subtasks for concept and reference modules where the usage of subsections might be legit. We might have to revisit it later.

      I created subtasks for concept and reference modules which contain actions verbs and should be requalified as procedure modules.

      I created subtasks for concept and reference modules using one unique subsection.

              ffloreth@redhat.com Fabrice Flore-Thébault
              ffloreth@redhat.com Fabrice Flore-Thébault
              RHIDP - Documentation
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: