From 3221034c95607cd1bb389500ba38c35f95d68dc9 Mon Sep 17 00:00:00 2001 From: miloschwartz Date: Sun, 27 Apr 2025 22:55:08 -0400 Subject: [PATCH] rearrange --- .../{ => 02-Getting Started}/01-overview.md | 0 ...choosing-a-vps.md => 07-choosing-a-vps.md} | 0 .../img/system-diagram.svg | 0 .../02-auto-provision.md | 2 +- .../03-Pangolin/07-API/01-integration-api.md | 10 +- packages/docusaurus/docusaurus.config.ts | 26 +-- packages/docusaurus/src/pages/index.tsx | 2 +- packages/docusaurus/src/pages/pricing.tsx | 151 ++++++++++-------- 8 files changed, 109 insertions(+), 82 deletions(-) rename packages/docusaurus/docs/{ => 02-Getting Started}/01-overview.md (100%) rename packages/docusaurus/docs/02-Getting Started/{01-choosing-a-vps.md => 07-choosing-a-vps.md} (100%) rename packages/docusaurus/docs/{ => 02-Getting Started}/img/system-diagram.svg (100%) diff --git a/packages/docusaurus/docs/01-overview.md b/packages/docusaurus/docs/02-Getting Started/01-overview.md similarity index 100% rename from packages/docusaurus/docs/01-overview.md rename to packages/docusaurus/docs/02-Getting Started/01-overview.md diff --git a/packages/docusaurus/docs/02-Getting Started/01-choosing-a-vps.md b/packages/docusaurus/docs/02-Getting Started/07-choosing-a-vps.md similarity index 100% rename from packages/docusaurus/docs/02-Getting Started/01-choosing-a-vps.md rename to packages/docusaurus/docs/02-Getting Started/07-choosing-a-vps.md diff --git a/packages/docusaurus/docs/img/system-diagram.svg b/packages/docusaurus/docs/02-Getting Started/img/system-diagram.svg similarity index 100% rename from packages/docusaurus/docs/img/system-diagram.svg rename to packages/docusaurus/docs/02-Getting Started/img/system-diagram.svg diff --git a/packages/docusaurus/docs/03-Pangolin/06-Identity Providers/02-auto-provision.md b/packages/docusaurus/docs/03-Pangolin/06-Identity Providers/02-auto-provision.md index 997ecaf..aaf28e6 100644 --- a/packages/docusaurus/docs/03-Pangolin/06-Identity Providers/02-auto-provision.md +++ b/packages/docusaurus/docs/03-Pangolin/06-Identity Providers/02-auto-provision.md @@ -1,4 +1,4 @@ -# Auto Provision (Professional) +# Auto Provision :::note diff --git a/packages/docusaurus/docs/03-Pangolin/07-API/01-integration-api.md b/packages/docusaurus/docs/03-Pangolin/07-API/01-integration-api.md index 1322b45..94583f4 100644 --- a/packages/docusaurus/docs/03-Pangolin/07-API/01-integration-api.md +++ b/packages/docusaurus/docs/03-Pangolin/07-API/01-integration-api.md @@ -1,4 +1,4 @@ -# Integration API (Professional) +# Integration API :::note @@ -22,6 +22,10 @@ Organization API keys can be created by organization admins from the Organizatio When you create or edit an API key, you can select the permissions that the API key will have. This allows you to create API keys with only the permissions that you need. +## Swagger Docs + +OpenAPI documentation is served via Swagger UI. You can access the documentation at `https://api.example.com/v1/docs`. + ## Configure Integration API The below example shows how to expose the Integration API. It will be accessible at `https://api.example.com/v1`. @@ -69,7 +73,3 @@ http: servers: - url: "http://pangolin:3003" # Integration API ``` - -## Swagger Docs - -OpenAPI documentation is served via Swagger UI. You can access the documentation at `https://api.example.com/v1/docs`. diff --git a/packages/docusaurus/docusaurus.config.ts b/packages/docusaurus/docusaurus.config.ts index 1da32ad..da177e8 100644 --- a/packages/docusaurus/docusaurus.config.ts +++ b/packages/docusaurus/docusaurus.config.ts @@ -50,17 +50,17 @@ const config: Config = { blog: { showReadingTime: true, feedOptions: { - type: ['rss', 'atom'], - xslt: true, + type: ["rss", "atom"], + xslt: true }, // Please change this to your repo. // Remove this to remove the "edit this page" links. - // editUrl: - // 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', + // editUrl: + // 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', // Useful options to enforce blogging best practices - onInlineTags: 'warn', - onInlineAuthors: 'warn', - onUntruncatedBlogPosts: 'warn', + onInlineTags: "warn", + onInlineAuthors: "warn", + onUntruncatedBlogPosts: "warn" }, theme: { customCss: "./src/css/custom.css" @@ -102,9 +102,9 @@ const config: Config = { type: "docSidebar", sidebarId: "tutorialSidebar", position: "left", - label: "Docs", + label: "Docs" }, - {to: '/pricing', label: 'Pricing', position: 'left'}, + { to: "/pricing", label: "Pricing", position: "left" }, { href: "https://fossorial.io", label: "fossorial.io", @@ -123,9 +123,9 @@ const config: Config = { }, { href: "https://support.fossorial.io", - label: "Support Portal (Professional License)", + label: "Support Portal", position: "left" - }, + } ] }, // footer: { @@ -198,18 +198,20 @@ const config: Config = { docsPluginId: "classic", // configured for preset-classic config: { petstore: { + hideSendButton: true, specPath: "./openapi.yml", outputDir: "docs/03-Pangolin/07-API/02-Routes", sidebarOptions: { groupPathsBy: "tag", categoryLinkSource: "tag", + sidebarCollapsible: true } } satisfies OpenApiPlugin.Options } } ] ], - themes: ["docusaurus-theme-openapi-docs"], // export theme components + themes: ["docusaurus-theme-openapi-docs"] // export theme components }; export default config; diff --git a/packages/docusaurus/src/pages/index.tsx b/packages/docusaurus/src/pages/index.tsx index 5cbfc87..e7dd356 100644 --- a/packages/docusaurus/src/pages/index.tsx +++ b/packages/docusaurus/src/pages/index.tsx @@ -3,7 +3,7 @@ import { useEffect } from "react"; export default function Home(): JSX.Element { useEffect(() => { // redirect to /overview - window.location.href = "/overview"; + window.location.href = "/Getting%20Started/overview"; }); return <>; diff --git a/packages/docusaurus/src/pages/pricing.tsx b/packages/docusaurus/src/pages/pricing.tsx index b4852db..58e46c2 100644 --- a/packages/docusaurus/src/pages/pricing.tsx +++ b/packages/docusaurus/src/pages/pricing.tsx @@ -94,6 +94,9 @@ const PricingComponent = () => { Check out the Supporter Program + +
Free
+