From 6da59779673d1cfe2b0d6460d9196d403c8a57f1 Mon Sep 17 00:00:00 2001 From: Rishi Verma Date: Wed, 20 Sep 2023 16:30:58 -0700 Subject: [PATCH 1/2] Update docusaurus.config.js Ensure relative links resolve well. Related to https://github.com/NASA-AMMOS/slim/issues/103 --- docusaurus.config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 6c1bb89a8..3b4e65cde 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -15,7 +15,7 @@ const config = { url: 'https://nasa-ammos.github.io', // Set the // pathname under which your site is served // For GitHub pages deployment, it is often '//' - baseUrl: '/slim', + baseUrl: '/slim/', // GitHub pages deployment config. // If you aren't using GitHub pages, you don't need these. From 4e898e54defc96345ce8e5f03434a55813b57c2f Mon Sep 17 00:00:00 2001 From: Rishi Verma Date: Wed, 20 Sep 2023 16:39:17 -0700 Subject: [PATCH 2/2] Update slim-registry.json Use more specific hostname independent absolute URIs to deal with https://github.com/NASA-AMMOS/slim/issues/103 --- static/data/slim-registry.json | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/static/data/slim-registry.json b/static/data/slim-registry.json index 496caeb21..b6c153481 100644 --- a/static/data/slim-registry.json +++ b/static/data/slim-registry.json @@ -1,7 +1,7 @@ [ { "title": "GOVERNANCE.md", - "uri": "governance/governance-model", + "uri": "/slim/docs/guides/governance/governance-model", "category": "governance", "description": "A governance model template seeking to generalize how most government-sponsored open source projects can expect to operate in the open source arena.", "tags": [ @@ -14,7 +14,7 @@ }, { "title": "Secrets Detection", - "uri": "software-lifecycle/security/secrets-detection", + "uri": "/slim/docs/guides/software-lifecycle/security/secrets-detection", "category": "software lifecycle", "description": "Detect-secrets is a security tool that scans code repositories to identify and prevent the accidental inclusion of sensitive information, such as API keys or passwords, by utilizing various detection techniques.", "tags": [ @@ -26,7 +26,7 @@ }, { "title": "README.md", - "uri": "documentation/readme", + "uri": "/slim/docs/guides/documentation/readme", "category": "documentation", "description": "A template that can be used to help developers and users understand your repository's project code concisely and clearly.", "tags": [ @@ -38,7 +38,7 @@ }, { "title": "Issue Ticket Templates", - "uri": "governance/contributions/issue-templates/", + "uri": "/slim/docs/guides/governance/contributions/issue-templates/", "category": "documentation", "description": "Issue tickets templates helping development teams keep the language of bug, feature, and other types of issues readable and consistent.", "tags": [ @@ -50,7 +50,7 @@ }, { "title": "Change Log", - "uri": "documentation/change-log/", + "uri": "/slim/docs/guides/documentation/change-log/", "category": "documentation", "description": "A guide on creating and maintaining a human-readable change log for software development projects, emphasizing the importance of a `CHANGELOG.md` file.", "tags": [ @@ -64,7 +64,7 @@ }, { "title": "Documentation Hosts", - "uri": "documentation/documentation-hosts/trade-study-hostingdocs-user", + "uri": "/slim/docs/guides/documentation/documentation-hosts/trade-study-hostingdocs-user", "category": "documentation", "description": "A guide on possible use cases and recommended tools for hosting various types of documentation with a call for contributions.", "tags": [ @@ -78,7 +78,7 @@ }, { "title": "Change Request Templates", - "uri": "governance/contributions/change-request-templates", + "uri": "/slim/docs/guides/governance/contributions/change-request-templates", "category": "governance", "description": "A guide outlining how to implement a pre-filled pull request template to provide guidance to potential contributors on GitHub.", "tags": [ @@ -92,7 +92,7 @@ }, { "title": "Code of Conduct", - "uri": "governance/contributions/code-of-conduct", + "uri": "/slim/docs/guides/governance/contributions/code-of-conduct", "category": "governance", "description": "A guide on how to create and implement a code of conduct for project teams, with a specific recommendation to use the Contributor Covenant.", "tags": [ @@ -107,7 +107,7 @@ }, { "title": "Contributing Guide", - "uri": "governance/contributions/contributing-guide", + "uri": "/slim/docs/guides/governance/contributions/contributing-guide", "category": "governance", "description": "A detailed guide about creating a contributing guide for your project, featuring a customizable template and instructions on how to use it.", "tags": [ @@ -122,7 +122,7 @@ }, { "title": "Developer Certificate of Origin (DCO)", - "uri": "governance/contributions/developer-certificate-origin", + "uri": "/slim/docs/guides/governance/contributions/developer-certificate-origin", "category": "governance", "description": "A guide on using a GitHub Action for automated checks on 'signed-off' commits from contributors.", "tags": [ @@ -137,7 +137,7 @@ }, { "title": "Python Starter Kit", - "uri": "software-lifecycle/application-starter-kits/python-starter-kit", + "uri": "/slim/docs/guides/software-lifecycle/application-starter-kits/python-starter-kit", "category": "software-lifecycle", "description": "A guide to a complete, deployment-ready Python 3 application that's bundled into a reusable template repository for quick implementation, with integrated build, release, and publish on GitHub.", "tags": [ @@ -155,7 +155,7 @@ }, { "title": "Continuous Integration Frameworks", - "uri": "software-lifecycle/continuous-integration/continuous-integration-frameworks", + "uri": "/slim/docs/guides/software-lifecycle/continuous-integration/continuous-integration-frameworks", "category": "software lifecycle", "description": "An overview of different continuous integration frameworks and their use cases.", "tags": [ @@ -168,7 +168,7 @@ }, { "title": "Reference Architectures", - "uri": "software-lifecycle/continuous-integration/reference-architecture", + "uri": "/slim/docs/guides/software-lifecycle/continuous-integration/reference-architecture", "category": "software lifecycle", "description": "A high-level reference guide for the implementation of continuous integration best practices, detailing structure, component interrelationships, and processes.", "tags": [ @@ -185,7 +185,7 @@ }, { "title": "Continuous Testing", - "uri": "software-lifecycle/continuous-testing/", + "uri": "/slim/docs/guides/software-lifecycle/continuous-testing/", "category": "software lifecycle", "description": "An extensive list of resources and tools for continuous testing including module testing, service endpoint testing, performance testing, and mobile testing among others.", "tags": [ @@ -199,4 +199,4 @@ ] - \ No newline at end of file +