Uploaded image for project: 'Connectivity Link'
  1. Connectivity Link
  2. CONNLINK-668

MCP Gateway Docs for Dev Preview

XMLWordPrintable

    • MCP Gateway Docs for Dev Preview
    • False
    • Hide

      None

      Show
      None
    • False
    • To Do

      For dev preview, let's ship docs for MCP Gateway upstream on docs.kuadrant.io (the upstream project where mcp-gateway lives)
      This is for 2 reasons:

      • dev preview doesn't necessarily mean any product/customer portal docs will be available (though it would be good to have a jump off point at least)
      • mitigate the risk of availability of a shared docs writer (rhn-support-shdiaz) with RHCL during the next RHCL release

      We have a draft PR that brings in upstream docs to a new top level tab in docs.kuadrant.io (https://github.com/Kuadrant/docs.kuadrant.io/pull/213)
      However, it's not a great experience as there is a mix of developer and user focused content, and some links only work within the git repo, not the site.

      I'd recommend a simple structure like this, with specific docs for the dev preview:

      • Overview (what is the mcp gateway, including some high level arch)
      • Installation - focus on openshift via helm
      • Guides - focus on a few key user journeys (registering an mcp server, adding authN, adding authZ, configuring a virtual MCP Server, configuring an external/off-cluster MCP Server)

      All other docs content in the repo should not be included in the site.
      This will limit the scope of reviewing and testing these docs with the limited capacity we have (may just be within engineering)

              Unassigned Unassigned
              davmarti@redhat.com David Martin
              Craig Brookes, David Martin, Mrunal Patel, Shane Utt
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: