Uploaded image for project: 'Docs for Red Hat Developers'
  1. Docs for Red Hat Developers
  2. RHDEVDOCS-4043

Ignore, remove, or identify deprecated fields in Che Operator CRD when generating doc

XMLWordPrintable

      Blocker as it is failing builds on che-docs.

      The page https://www.eclipse.org/che/docs/next/administration-guide/checluster-custom-resource-fields-reference/ contains a broken link to https://developers.redhat.com/products/codeready-workspaces/overview.

      That URL is not published (yet)

      As it belongs to the description of a deprecated field, remove the link entirely, and maybe remove the description that is not relevant.

      The fix is to happen in the che source code, not in che-docs.

      Quoting Fabrice:

      first thing: this doc is generated. The file to change is https://github.com/eclipse-che/che-operator/blob/main/config/crd/bases/org_v1_che_crd.yaml
      Second thing: we don't need to change the link for a better one. We need to remove that link. Because the description is misleading. "Deprecated. The value of this flag is ignored." is a sufficient description.
      Moreover, the cleanest fix would be probably to ignore in the table all deprecated fields. But it requires hacking the script, we won't have it today.
      So maybe:
      ...
      Step 2: Cleanup https://github.com/eclipse-che/che-operator/blob/main/config/crd/bases/org_v1_che_crd.yaml - Remove misleading description in all "Deprecated. The value of this flag is ignored." fields.
      Step 2bis: Modify the single-sourcing script to skip all deprecated fields in the output table. (Or does it make sense to keep them?)

              ffloreth@redhat.com Fabrice Flore-Thébault
              rhn-support-mleonov Max Leonov
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: