Uploaded image for project: 'Red Hat Developer Hub Bugs'
  1. Red Hat Developer Hub Bugs
  2. RHDHBUGS-1152

RHDH Local README needs revisions

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Major Major
    • 1.7.0
    • 1.5.0
    • Documentation, RHDH Local
    • None
    • 2
    • False
    • Hide

      None

      Show
      None
    • False
    • Release Note Not Required
    • Release Note Not Required
    • Rejected
    • RHDH Install 3274, RHDH Install 3275, RHDH Install 3276, RHDH Install 3277
    • Moderate

      Overview (aka. Goal Summary)

      The README for RHDH Local hasn't kept up with recent developments, specifically:

      1. The introduction of the new configuration and customization plan and how to use it to avoid upgrade (git pull) issues. This includes how to override defaults for application config, plugin config, etc. 
      2. The use of the latest podman cli commands (e.g. use `podman compose`)
      3. Equal weight to docker and podman must be maintained (the README has become very podman heavy, but >80% of developers use Docker)
      4. Changes to Postgres setup now the quay registry for the image requires a login?

      Also, certain basic information about the bootstrapping procedure aren't part of the getting started guide such as:

      • Where to point your browser once the container has booted
      • How to login for the first time (using the guest)

      Goals for the changes proposed (aka. expected user outcomes)

      • RHDH Local must remain easy to bootstrap, simple to use, clearly documented, and user friendly - the outdated and incomplete README is causing friction to this project goal
      • Meet developers where they are - for example, they are mostly on Docker, so give Podman and Docker commands equal weight
      • Use the latest cli commands - both docker and podman no longer use hypenated cli commands, the clis for compose have been consolidated into the primary container cli in both cases.

      Requirements (aka. Acceptance Criteria):

      Revised README is created which covers the user's journey from getting started to advanced configuration

      Out of Scope (Optional)

      Going forwards, ideally the README and the RHDH documentation for RHDH Local would be developed together and used to promote the simple approach to getting started with RHDH Local and the advanced configuration and testing that is possible with RHDH Local

      Customer Considerations (Optional)

      Existing users upgrading from earlier revisions may currently find the lack of documentation on the new approach introduces friction to their upgrade (git pull). Let's try and use the README and documentation to remove this friction.

      Documentation Considerations

      All of the above

              lahern Leanne Ahern
              rh-ee-bwilcock Ben Wilcock
              RHIDP - Install
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: