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

Doc Error - Usage of deprecated "attributes" in metadata of devfile - Openshift Dev Spaces

XMLWordPrintable

    • False
    • Hide

      None

      Show
      None
    • False

      Description of problem:

      There is a doc error in the example  given for "Allow pod-overrides for volumes and container-overrides for volumeMounts in Devfiles" section in our Official Doc 

       [1]https://docs.redhat.com/en/documentation/red_hat_openshift_dev_spaces/3.12/html/release_notes_and_known_issues/new-features#enhancement-crw-5956

      In docs, "Attributes" is under "metadata", but that usage is deprecated/removed.

      • metadata: Attributes in metadata are deprecated. Use top-level attributes instead.

      Prerequisites (if any, like setup, operators/versions):

      Openshift Dev Spaces 3.16

      Steps to Reproduce

      Check the example in [1]

      Actual results:

      "attributes" is under metadata and so the example given there won't work.

      metadata:
        name: pod-overrides-example
        attributes: <----
          pod-overrides:
            spec:
              volumes: 

      Expected results:

      Doc should be updated and "attributes" shouldn't be placed under "metadata" so that example would work

      metadata:
        name: pod-overrides-example
      attributes: <----
        pod-overrides:
          spec:
            volumes: 

      Reproducibility (Always/Intermittent/Only Once):

      Always

      Acceptance criteria: 

       

      Definition of Done:

      Build Details:

      Additional info (Such as Logs, Screenshots, etc):

      Reference: https://devfile.io/docs/2.2.0/defining-attributes

       

              dakwon@redhat.com David Kwon
              rhn-support-gio Ginilekshmi A O (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: