Uploaded image for project: 'Red Hat 3scale API Management'
  1. Red Hat 3scale API Management
  2. THREESCALE-10246

Improve documentation organization for 3scale "flavors": SaaS, on-premises, RHOAM

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Unresolved
    • Icon: Major Major
    • None
    • None
    • Documentation
    • 5
    • False
    • None
    • False
    • Not Started
    • Not Started
    • Not Started
    • Not Started
    • Not Started
    • Not Started

      There are several issues with the current organization of 3scale documentation, caused by the fact that it has several "flavors":

      • SaaS
      • on-premises
      • RHOAM

      Currently, SaaS and on-premises are under the same "product" - Red Hat 3scale API Management: https://access.redhat.com/documentation/en-us/red_hat_3scale_api_management, the product versions being `2-saas`and `2.x` accordingly.

      However, this is how it is seen on the index page, the actual content for SaaS is somehow "hosted" under the product Red Hat 3Scale - https://access.redhat.com/documentation/en-us/red_hat_3scale/2-saas

      (you can see it if you click on any doc from https://access.redhat.com/documentation/en-us/red_hat_3scale_api_management/2-saas)

      This is very confusing!

      Also, RHOAM has its own documentation, under Red Hat OpenShift API Management product, with its own (rudimentary) versioning
      https://access.redhat.com/documentation/en-us/red_hat_openshift_api_management/

      This documentation only covers the information that is specific to RHOAM, but doesn't include all the generic information about the product itself which is still relevant to RHOAM (e.g. using the admin and developer portal etc.). This is also confusing.
      Specifically, because in the admin portal we have some links pointing to the documentation. But in RHOAM we currently cannot point them to RHOAM documentation, because this content does not exist there (see this thread for more context).
      The fix that was applied was pointing to SaaS docs from RHOAM-hosted admin portal, which is not idea.

      So, we need to discuss and possibly implement the following potential improvements:

      • either unify the docs - i.e. make RHOAM a "version" of Red Hat 3scale API Management, or copy-paste the relevant content from 3scale docs to RHOAM docs, so that RHOAM docs are complete.
      • remove all links to the documentation from the admin portal, so it's not confusing to the user
      • remove the discrepancy between SaaS and on-premises docs - i.e. get rid of "Red Hat 3Scale" product and merge it into "Red Hat 3scale API Management"

            dfenness@redhat.com Darren Fennessy
            rhn-support-dmayorov Daria Mayorova
            Darren Fennessy Darren Fennessy
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: