Uploaded image for project: 'Ansible Automation Platform RFEs'
  1. Ansible Automation Platform RFEs
  2. AAPRFE-1204

Fix documentation on collection creation

XMLWordPrintable

    • False
    • Hide

      None

      Show
      None
    • False

      1. What is the nature and description of the request?

      Our documentation on creating a collection, see here:
      https://docs.ansible.com/ansible/latest/dev_guide/collections_galaxy_meta.html

      says that License and License_file are optional.  Indeed, the ansible-galaxy collection build command does not check if they are there or not, or if the file exists.

      However, when loading the collection up to a PAH, the hub checks things inside the collection and requires one of the two settings to be set. 

      If not set you get the error:

      "Invalid collection metadata. Valid values for 'license' or 'license_file' are required. But 'license' ([]) and 'license_file' (None) were invalid."

       

      2. Why does the customer need this? (List the business requirements here)

      This makes it very confusing for people who are trying to learn to create collections.

       

      3. How would you like to achieve this? (List the functional requirements here)

      We should update our documentation to meet the standards that PAH imposes for collections or at least update the documentation for what PAH requires.

       

              stevefulme1 Stephen Fulmer
              rhn-support-gscarbor Gary Scarborough
              Votes:
              1 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: