links + minor fixes

MitchellShiell · MitchellShiell · commit 8121b8b74de0 · 2024-10-31T11:34:47.000-04:00
diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ Our documentation is split up as follows:
 | Developer/Product Documentation | Software Engineers & Developers | Technical resources for those working on or contributing to the project. | 
 | Platform Guides | IT Specialists & Informaticians | Instructive guides covering platform setup, maintenance and usage for end-users and administrators. |
 
-## How OvertureDev Works
+## How OvertureDocs Works
 
 - **Docusaurus**: We use Docusaurus to render the site, providing a sleek and navigable interface for our documentation.
 
@@ -47,7 +47,7 @@ Our documentation is split up as follows:
 To clone the repository with the files in the submodules:
 
 ```bash
-git clone --recurse-submodules https://github.com/MitchellShiell/bridge.git
+git clone --recurse-submodules https://github.com/overture-stack/docs.git
 ```
 
 Install required dependencies:
diff --git a/submodules/.github b/submodules/.github
@@ -1 +1 @@
-Subproject commit bbfeedbb9b973a0bd3d3be9a282fb5faf138f4b4
+Subproject commit e1675a81d3acc73d4dc375177e1b63aed8b9efa1
diff --git a/submodules/arranger b/submodules/arranger
@@ -1 +1 @@
-Subproject commit 86d7a09abcedaf0b776d06b750fa923c553c39e7
+Subproject commit f8fa29ffd4832f7244162ae33990124e2270fa73
diff --git a/submodules/lectern b/submodules/lectern
@@ -1 +1 @@
-Subproject commit f68be10f714d8cc372b82a527fbf5ca01d8ec678
+Subproject commit 516a2bad00b8afd9c2e5b7e73bb27788a4397d71
diff --git a/submodules/lyric b/submodules/lyric
@@ -1 +1 @@
-Subproject commit 4d6ca5201ac816a777b096a29a7b132c4a648454
+Subproject commit 90cfefd4fa3099c8c140178daf3d32c4bf7f4183
diff --git a/submodules/maestro b/submodules/maestro
@@ -1 +1 @@
-Subproject commit fe39450fcb70d9edf8b393734998a0341d014554
+Subproject commit 2be105b032f79da33a2863b7201146e30e4c0662
diff --git a/submodules/score b/submodules/score
@@ -1 +1 @@
-Subproject commit 1ba8373d34e78e79ee11f9f26f6304ff96c7e5de
+Subproject commit dc8a4c2cd245200722a44e486616430323577f99
diff --git a/submodules/song b/submodules/song
@@ -1 +1 @@
-Subproject commit 918f5e200ddd6066b74cd6a01e7a4c5a87d46757
+Subproject commit 9ccf47ed6f2a19654414c01a3cc729961dfe142a
diff --git a/submodules/stage b/submodules/stage
@@ -1 +1 @@
-Subproject commit ab08c52f86f54ef0e502a780d9ad7e77d8890f63
+Subproject commit 9a22c8000a096054d6b849888d37e5e8b55672fb
diff --git a/website/community/00-support.md b/website/community/00-support.md
@@ -8,7 +8,7 @@ Our primary platform for community support, feature requests, and general discus
 
 ### Getting Help
 
-- [**Create a Support Discussion**](https://github.com/MitchellShiell/bridge/discussions/categories/support)
+- [**Create a Support Discussion**](https://github.com/overture-stack/docs/discussions/categories/support)
     - If you need assistance with Overture, please create a new discussion in our support category.
     - Before creating a new discussion, please search existing discussions to see if your question has already been answered.
 
@@ -20,7 +20,7 @@ We love hearing your ideas for improving Overture! Before making a feature reque
 
 If your idea isn't on the roadmap, feel free to create a new discussion in our Ideas category:
 
-- [**Submit a Feature Request**](https://github.com/MitchellShiell/bridge/discussions/categories/ideas)
+- [**Submit a Feature Request**](https://github.com/overture-stack/docs/discussions/categories/ideas)
 
 ## GitHub Issues
 
@@ -30,15 +30,15 @@ We use GitHub Issues primarily for tracking confirmed bugs and ticketing develop
 
 If you come across a potential bug or issue, please post it as a GitHub support discussion first:
 
-- [**Report a Potential Bug**](https://github.com/MitchellShiell/bridge/discussions/categories/support)
+- [**Report a Potential Bug**](https://github.com/overture-stack/docs/discussions/categories/support)
 
 This allows us to confirm the issue and gather more information if needed. If we determine that further development is required, we will create a GitHub Issue from your discussion post.
 
 ## Staying Informed
 
 ### Release Announcements
 
-- [**Release Announcements**](https://github.com/MitchellShiell/bridge/discussions/categories/announcements)
+- [**Release Announcements**](https://github.com/overture-stack/docs/discussions/categories/announcements)
     - To stay up-to-date with the latest Overture releases and updates, keep an eye on our Announcements category in our GitHub Discussions
 
 ## Community Guidelines
diff --git a/website/community/04-contribution.md b/website/community/04-contribution.md
@@ -15,13 +15,13 @@ By participating in this project, you are expected to abide by our [Code of Cond
 **Getting Started:** Our primary platform for community support, feature requests, and general discussions is GitHub Discussions. This allows us to keep all conversations in one place and make them easily searchable for future reference.
 
 
-**Community Support:** Our primary platform for community support, feature requests, and general discussions is [GitHub Discussions](https://github.com/MitchellShiell/bridge/discussions). This allows us to keep all conversations in one place and make them easily searchable for future reference.
+**Community Support:** Our primary platform for community support, feature requests, and general discussions is [GitHub Discussions](https://github.com/overture-stack/docs/discussions). This allows us to keep all conversations in one place and make them easily searchable for future reference.
 
-- **Getting Help:** If you need assistance with Overture, please create a [new discussion in our support category](https://github.com/MitchellShiell/bridge/discussions/categories/support).
+- **Getting Help:** If you need assistance with Overture, please create a [new discussion in our support category](https://github.com/overture-stack/docs/discussions/categories/support).
   - Before creating a new discussion, please search existing discussions to see if your question has already been answered.
 - **Feature Requests & Proposals:** We love hearing your ideas for improving Overture! Before making a feature request, please check our [**current roadmap**](https://github.com/users/MitchellShiell/projects/2/views/4) to see if your idea is already planned.
-  - If your idea isn't on the roadmap, feel free to [**submit a feature request**](https://github.com/MitchellShiell/bridge/discussions/categories/ideas) by creating a new discussion in our Ideas category 
-- **Report a Potential Bug:** We use GitHub Issues primarily for tracking confirmed bugs and ticketing development tasks. If you come across a potential bug or issue, please first post it to our [**GitHub support discussion forum**](https://github.com/MitchellShiell/bridge/discussions/categories/support).
+  - If your idea isn't on the roadmap, feel free to [**submit a feature request**](https://github.com/overture-stack/docs/discussions/categories/ideas) by creating a new discussion in our Ideas category 
+- **Report a Potential Bug:** We use GitHub Issues primarily for tracking confirmed bugs and ticketing development tasks. If you come across a potential bug or issue, please first post it to our [**GitHub support discussion forum**](https://github.com/overture-stack/docs/discussions/categories/support).
   - This allows us to confirm the issue and gather more information if needed. If we determine that further development is required, we will create and tag you into a GitHub Issue from your discussion post.
 
 ## Our Development Process
diff --git a/website/docs/00-getting-started.mdx b/website/docs/00-getting-started.mdx
@@ -1,7 +1,3 @@
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import DocCardList from '@theme/DocCardList';
-
 # Getting Started
 
 Our documentation is the definitive resource for the Overture project. Here you'll find comprehensive guides for implementing our software in development environments, up-to-date documentation on products under active development, technical standards, and additional resources.
diff --git a/website/docs/01-core-software/01-core-software.mdx b/website/docs/01-core-software/01-core-software.mdx
@@ -1,9 +1,5 @@
 # Core Software
 
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import DocCardList from '@theme/DocCardList';
-
 ![Core Software](./images/core-software.webp 'Core Software')
 
 :::info
diff --git a/website/docs/03-other-software/01-Bridge.md b/website/docs/03-other-software/01-Bridge.md
@@ -3,6 +3,10 @@
 
 Bridge is a single, easy-to-navigate hub that beautifully renders all our product documentation from the `/docs` folder of all our GitHub repositories. 
 
+:::info 
+Overture Docs started under the name Bridge to reflect its ability to bridge information across multiple repositories. Bridge was also chosen in fitting with Overtures Orchestral theme.
+:::
+
 ## Documentation Framework
 
 Overture has three user profiles:
@@ -20,7 +24,7 @@ Our documentation is split up as follows:
 | Product Documentation (Housed here) | Software Engineers & Developers | Technical resources for those working on or contributing to the project. | 
 | Platform Guides (Overture.bio)  | IT Specialists & Informaticians | Instructive guides covering platform setup, maintenance and usage for end-users and administrators. |
 
-## How OvertureDev Works
+## How Overture Docs Works
 
 - **Docusaurus**: We use Docusaurus to render the site, providing a sleek and navigable interface for our documentation.
 
@@ -40,14 +44,20 @@ Our documentation is split up as follows:
 
 - **Robust Error Handling**: Docusaurus has excellent error catching, particularly for broken and missing links, reducing the need for manual testing.
 
+![Pro Tip](./images/proTip.png 'Use Overture Docs repo to search across all Overture repos')
+
+  :::tip Pro Tip
+  The Overture Docs repo contains everything, therefore finding & tracking links and content across all our repos has never been easier.
+  :::
+
 ## Getting Started
 
 ### Running it Locally
 
 To clone the repository with the files in the submodules:
 
 ```bash
-git clone --recurse-submodules https://github.com/MitchellShiell/bridge.git
+git clone --recurse-submodules https://github.com/overture-stack/docs.git
 ```
 
 Install required dependencies:
@@ -123,3 +133,49 @@ plugins: ['./docsPlugin.ts'],
 ```
 
 The source of this fix can be found [here](https://github.com/facebook/docusaurus/issues/3272#issuecomment-688409489).
+
+## Globally imported Mdx components
+
+We can import components by default across all our mdx files reducing the head matter when using these components in mdx documents. This can be configured from the `/src/theme/MDXComponents.ts`:
+
+```ts title="MDXComponents.ts"
+import type {ComponentType} from 'react';
+import MDXComponents from '@theme-original/MDXComponents';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+
+const components: typeof MDXComponents & {
+    Tabs: ComponentType<any>;
+    TabItem: ComponentType<any>;
+    DocCardList: ComponentType<any>;
+} = {
+  ...MDXComponents,
+  Tabs,
+  TabItem,
+  DocCardList,
+};
+
+export default components;
+```
+
+## Custom Components 
+
+There are three custom components built for this site all located in the components directory as follows:
+
+```
+.
+└── /src/
+    └── components/
+        ├── FundingStatment
+        ├── SiteMap
+        └── SwaggerAPIDoc
+```
+
+### Site Map
+
+### Sidebar Funding Statement
+
+### Swagger API Embed
+
+
diff --git a/website/docs/03-other-software/02-Conductor.mdx b/website/docs/03-other-software/02-Conductor.mdx
@@ -1,6 +1,3 @@
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
 # Conductor 
 
 Conductor is a flexible Docker Compose setup that simplifies the process of spinning up Overture development and deployment configurations using Docker profiles and extensible scripting events.
diff --git a/website/docs/03-other-software/03-Other-Software.mdx b/website/docs/03-other-software/03-Other-Software.mdx
@@ -2,6 +2,6 @@
 
 This section provides information on supplemental software that, while not directly integrated into the Overture platform, is part of the broader Overture project. Although primarily used for internal purposes, feel free to explore the documentation for these tools that support our open-source initiative.
 
-import DocCardList from '@theme/DocCardList';
+
 
 <DocCardList />
diff --git a/website/docs/03-other-software/images/proTip.png b/website/docs/03-other-software/images/proTip.png
diff --git a/website/docs/contribution.md b/website/docs/contribution.md
@@ -15,13 +15,13 @@ By participating in this project, you are expected to abide by our [Code of Cond
 **Getting Started:** Our primary platform for community support, feature requests, and general discussions is GitHub Discussions. This allows us to keep all conversations in one place and make them easily searchable for future reference.
 
 
-**Community Support:** Our primary platform for community support, feature requests, and general discussions is [GitHub Discussions](https://github.com/MitchellShiell/bridge/discussions). This allows us to keep all conversations in one place and make them easily searchable for future reference.
+**Community Support:** Our primary platform for community support, feature requests, and general discussions is [GitHub Discussions](https://github.com/overture-stack/docs/discussions). This allows us to keep all conversations in one place and make them easily searchable for future reference.
 
-- **Getting Help:** If you need assistance with Overture, please create a [new discussion in our support category](https://github.com/MitchellShiell/bridge/discussions/categories/support).
+- **Getting Help:** If you need assistance with Overture, please create a [new discussion in our support category](https://github.com/overture-stack/docs/discussions/categories/support).
   - Before creating a new discussion, please search existing discussions to see if your question has already been answered.
 - **Feature Requests & Proposals:** We love hearing your ideas for improving Overture! Before making a feature request, please check our [**current roadmap**](https://github.com/users/MitchellShiell/projects/2/views/4) to see if your idea is already planned.
-  - If your idea isn't on the roadmap, feel free to [**submit a feature request**](https://github.com/MitchellShiell/bridge/discussions/categories/ideas) by creating a new discussion in our Ideas category 
-- **Report a Potential Bug:** We use GitHub Issues primarily for tracking confirmed bugs and ticketing development tasks. If you come across a potential bug or issue, please first post it to our [**GitHub support discussion forum**](https://github.com/MitchellShiell/bridge/discussions/categories/support).
+  - If your idea isn't on the roadmap, feel free to [**submit a feature request**](https://github.com/overture-stack/docs/discussions/categories/ideas) by creating a new discussion in our Ideas category 
+- **Report a Potential Bug:** We use GitHub Issues primarily for tracking confirmed bugs and ticketing development tasks. If you come across a potential bug or issue, please first post it to our [**GitHub support discussion forum**](https://github.com/overture-stack/docs/discussions/categories/support).
   - This allows us to confirm the issue and gather more information if needed. If we determine that further development is required, we will create and tag you into a GitHub Issue from your discussion post.
 
 ## Our Development Process
diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts
@@ -3,7 +3,7 @@ import type {Config} from '@docusaurus/types';
 import type * as Preset from '@docusaurus/preset-classic';
 
 const config: Config = {
-  title: 'OvertureDev',
+  title: 'Overture Docs',
   tagline: 'Docs for Developers & Informaticians',
   favicon: 'img/favicon.ico',
 
@@ -16,7 +16,7 @@ const config: Config = {
   // GitHub pages deployment config.
   // If you aren't using GitHub pages, you don't need these.
   organizationName: 'overture-stack', // Usually your GitHub org/user name.
-  projectName: 'OvertureDev', // Usually your repo name.
+  projectName: 'Overture Docs', // Usually your repo name.
 
   onBrokenLinks: 'throw',
   onBrokenMarkdownLinks: 'warn',
@@ -93,9 +93,9 @@ const config: Config = {
     // Replace with your project's social card
     image: 'img/docusaurus-social-card.jpg',
     navbar: {
-      title: 'OvertureDev',
+      title: 'Overture Docs',
       logo: {
-        alt: 'Overture Dev Logo',
+        alt: 'Overture Docs Logo',
         src: 'img/Overture-logo.png',
       },
       items: [
@@ -164,7 +164,7 @@ const config: Config = {
       appId: 'E70KV3D0W2',
       // Public API key
       apiKey: '296266a1c98ef42e60e0d9cb2f0c48a7',
-      indexName: 'overtureDev',
+      indexName: 'overtureDocs',
     },
   } satisfies Preset.ThemeConfig,
 };
diff --git a/website/guides/00-getting-started.mdx b/website/guides/00-getting-started.mdx
@@ -1,4 +1,4 @@
-import DocCardList from '@theme/DocCardList';
+
 
 # Getting Started
 
diff --git a/website/guides/03-user-guides/03-user-guides.mdx b/website/guides/03-user-guides/03-user-guides.mdx
@@ -2,6 +2,6 @@
 
 Using the Overture platform for data submission and retrieval.
 
-import DocCardList from '@theme/DocCardList';
+
 
 <DocCardList />
diff --git a/website/src/components/SiteMap/index.tsx b/website/src/components/SiteMap/index.tsx
@@ -24,11 +24,11 @@ interface Category {
 const categories: Record<string, Category> = {
   platform: {
     title: 'Platform Guides',
-    description: 'Bringing it all together into one cohesive platform'
+    description: 'Bringing it all together with platform focused guides'
   },
   core: {
     title: 'Developer Documentation',
-    description: 'Using our software microservices in a development context'
+    description: 'Using our software in a development context'
   },
   development: {
     title: 'Under Development',
diff --git a/website/src/components/SiteMap/styles.module.css b/website/src/components/SiteMap/styles.module.css
@@ -56,14 +56,14 @@
   align-items: center;
   padding: 1rem;
   border-radius: 10px;
-  box-shadow: 0 2px 5px rgba(0, 0, 0, 0.1);
+  box-shadow: 0 1px 2px rgba(0, 0, 0, 0.1);
   transition: transform 0.3s ease, box-shadow 0.3s ease;
   background-color: var(--category-card-color);
 }
 
 .card:hover, .card:focus {
-  transform: translateY(-5px);
-  box-shadow: 0 4px 10px rgba(0, 0, 0, 0.15);
+  transform: translateY(-2px);
+  box-shadow: 0 1px 2px rgba(0, 0, 0, 0.15);
   text-decoration: none;
   outline: none;
 }
@@ -94,7 +94,7 @@
   margin-top: 2rem;
   padding: 2rem;
   background-color: var(--funding-block-color);
-  box-shadow: var(--category-block-shadow-funding);
+  box-shadow: var(--category-block-shadow); 
   border-radius: 12px;
   position: relative;
   overflow: hidden;
@@ -126,14 +126,14 @@
   border-radius: 6px;
   font-weight: bold;
   transition: all 0.3s ease;
-  box-shadow: 0 2px 10px rgba(0, 0, 0, 0.1);
+  box-shadow: 0 1px 2px rgba(0, 0, 0, 0.1);
 }
 
 .fundingLink:hover {
   color: var(--category-title-color);
   text-decoration: none;
   transform: translateY(-2px);
-  box-shadow: 0 4px 15px rgba(0, 0, 0, 0.15);
+  box-shadow: 0 1px 2px rgba(0, 0, 0, 0.15);
 }
 
 @media (max-width: 768px) {
diff --git a/website/src/css/custom.css b/website/src/css/custom.css
@@ -20,7 +20,7 @@
   --category-title-color: #282A35;
   --category-category-color: #f5f5f5;
   --category-card-color: #fefefe;
-  --category-block-shadow: 2px 2px 10px #282a3563;
+  --category-block-shadow: 2px 2px 6px #282a3516;
   --category-block-funding: none;
   --funding-block-color: #edf9fd;
 }
diff --git a/website/src/theme/MDXComponents.ts b/website/src/theme/MDXComponents.ts
@@ -0,0 +1,19 @@
+import type {ComponentType} from 'react';
+import MDXComponents from '@theme-original/MDXComponents';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import DocCardList from '@theme/DocCardList'
+
+
+const components: typeof MDXComponents & {
+    Tabs: ComponentType<any>;
+    TabItem: ComponentType<any>;
+    DocCardList: ComponentType<any>;
+} = {
+  ...MDXComponents,
+  Tabs,
+  TabItem,
+  DocCardList,
+};
+
+export default components;
