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

Update service discovery doc - for Integration doc reuse

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • Major
    • 2.8 GA
    • 2.8 ER1
    • Documentation
    • None
    • integration-doc-2020-03-09

    Description

      Updates for the Admin Portal Guide in the 3scale-documentation repo:
      1) modules/service-discovery/p_service-discovery-procedure.adoc
      need to replace xref links to service-discovery-authorization with <<>> links
      2) modules/service-discovery/c_service-discovery-concept.adoc
      Move "Criteria for a discoverable service" section to a new concept module
      3) modules/service-discovery/c_service-discovery-criteria.adoc (new)
      4) assemblies/service-discovery/as_service-discovery.adoc
      Add link to new concept module: c_service-discovery-criteria.adoc
      5) modules/service-discovery/p_service-discovery-procedure.adoc
      "conditionalize" the prerequisites so that they do not appear for the RHMI version of the doc
      Add a prereq that the Fuse Online developer must have published the API s that it is available on the cluster
      update this preerq as follows:
      Change:
      "For example, for Fuse Online APIs, the OpenShift administrator must set the OPENSHIFT_MANAGEMENT_URL_FOR3SCALE environment variable to the

      {ProductShortName}

      URL."
      To:
      For example, for the OpenShift administrator must have enabled 3scale discovery by editing the Fuse Online custom resource to specify the URL for their 3scale user interface.
      6) Due to title change of Integration repo book, need to update topics/create-activedocs-spec.adoc

      https://access.redhat.com/documentation/en-us/red_hat_integration/

      {IntegrationVersion}/html-single/developing_and_deploying_apis_with_red_hat_integration/
      Developing and Deploying APIs with Red Hat Integration
      to
      https://access.redhat.com/documentation/en-us/red_hat_integration/{IntegrationVersion}

      /html-single/developing_and_deploying_api_provider_integrations/
      Developing and Deploying API Provider Integrations

      Checked with Priscill - need to wait until after https://issues.redhat.com/browse/THREESCALE-4211 is merged

      Attachments

        Issue Links

          Activity

            People

              mflinn@redhat.com Melissa Flinn
              mflinn@redhat.com Melissa Flinn
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - 1 day Original Estimate - 1 day
                  1d
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 1 day, 3 hours
                  1d 3h