docs: implement multi-tenancy updates & add versioning (#3639)

* WIP: multi-tenancy docs updates in progress

* docs: draft multi-tenancy updates

- Added integration>requirements>tenants
- Updated existing pages

* docs: prettier

our good, forgotten friend

* Update backend-service.mdx

* docs: feedback implemented

Priority items: Operator must generate UUID v4 OPERATOR_TENANT_ID and API_SECRET, tenant's credentials need to be communicated to the tenant out of band, and request signing update

* docs: feedback from Max

Minor edits

* docs: more feedback

Minor fixes

* docs: quick fix and run pnpm format

* docs: add starlight-versions (#3665)

* docs: add starlight-versions

* docs: add VersionSelect in header

* docs: remove unused helm/k8s text

* docs: add es to spanish landing page link

* chore(docs): use starlight-versions from github to test

* feat(docs): add new version

* feat(docs): add generated version

* Revert "feat(docs): add generated version"

This reverts commit fa97df9.

* feat(docs): use updated starlight-version version

* feat(docs): add generated docs with new version

* docs: generate v1-beta spectaql docs from v1.2.0 release

* docs: generate updated spectaql files

* chore(docs): update table formatting

* feat(docs): replace Search with VersionSearch

* chore(docs): update table formatting

* chore(docs): formatting

* chore(docs): fix full docker compose example file

* chore(docs): fix dollar sign literal

* chore(docs): fix integration checklist

* chore(docs): replace v1-beta partials with inline, non-MT env variables

* chore(docs): format

* chore(docs): add es v1-beta Admin APIs

* chore(docs): simplify link validator exclude glob pattern

* chore(docs): fix $ formatting in es v1-beta doc

* chore(docs): remove partial for services environment variables

* chore(docs): remove MT related env flags from service overviews

* chore(docs): formatting

* docs: tidy delete-peer image

* docs: remove SIGNATURE_SECRET from frontend variables

* docs: update environment variables with recent changes

* docs: update SERVICE_API_PORT auth variable

* docs: regenerate grapqhl API docs

---------

Co-authored-by: Max Kurapov <[email protected]>

Author: brad-dow

packages/documentation/astro.config.mjs

@@ -7,6 +7,7 @@ import starlightLinksValidator from 'starlight-links-validator'
 import starlightFullViewMode from 'starlight-fullview-mode'
 import { rehypeHeadingIds } from '@astrojs/markdown-remark'
 import rehypeAutolinkHeadings from 'rehype-autolink-headings'
+import starlightVersions from 'starlight-versions'
 
 // https://astro.build/config
 export default defineConfig({
@@ -112,6 +113,10 @@ export default defineConfig({
                   },
                   link: '/overview/concepts/account-servicing-entity'
                 },
+                {
+                  label: 'Multi-tenancy',
+                  link: '/overview/concepts/multi-tenancy'
+                },
                 {
                   label: 'Accounting',
                   translations: {
@@ -184,6 +189,10 @@ export default defineConfig({
                   label: 'Overview and checklist',
                   link: '/integration/requirements/overview'
                 },
+                {
+                  label: 'Tenants',
+                  link: '/integration/requirements/tenants'
+                },
                 {
                   label: 'Assets',
                   link: '/integration/requirements/assets'
@@ -358,12 +367,18 @@ export default defineConfig({
         }
       ],
       plugins: [
+        starlightVersions({
+          current: {
+            label: 'v2-beta'
+          },
+          versions: [{ slug: 'v1-beta' }]
+        }),
         starlightLinksValidator({
           exclude: [
-            '/apis/graphql/auth',
-            '/apis/graphql/backend',
-            '/apis/graphql/auth/*',
-            '/apis/graphql/backend/*'
+            '**/apis/graphql/auth',
+            '**/apis/graphql/backend',
+            '**/apis/graphql/auth/*',
+            '**/apis/graphql/backend/*'
           ],
           errorOnLocalLinks: false,
           errorOnFallbackPages: false,

packages/documentation/package.json

@@ -5,6 +5,7 @@
   "scripts": {
     "start": "astro dev",
     "build:docs": "astro build",
+    "build:docs:graphql": "spectaql config-auth.yml && spectaql config-backend.yml",
     "preview": "astro preview",
     "astro": "astro"
   },
@@ -19,6 +20,7 @@
     "remark-math": "^6.0.0",
     "spectaql": "^3.0.4",
     "starlight-fullview-mode": "^0.2.3",
-    "starlight-links-validator": "^0.17.0"
+    "starlight-links-validator": "^0.17.0",
+    "starlight-versions": "^0.5.5"
   }
 }