secureCodeBox · Weltraumschaf · Oct 17, 2023 · Oct 17, 2023 · Oct 17, 2023 · Oct 17, 2023
diff --git a/.gitignore b/.gitignore
@@ -57,3 +57,16 @@ tags
 
 # Megalint report dir
 report
+
+# Documentation
+## Documentation build files
+documentation/.docusaurus
+documentation/.cache-loader
+## Documentation generated files
+documentation/docs/scanners/*.md
+documentation/docs/hooks/*.md
+## Always overwitten during the build
+documentation/src/integrations.js
+## Copied over during the build
+documentation/static/findings
+
diff --git a/documentation/docusaurus.config.js b/documentation/docusaurus.config.js
@@ -37,6 +37,9 @@ module.exports = {
   themeConfig:
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
     ({
+      metadata: [
+        {name: 'og:image', content: 'img/Og_image.png'},
+      ],
       navbar: {
         logo: {
           alt: "secureCodeBox Logo",
@@ -73,7 +76,7 @@ module.exports = {
             items: [
               {
                 label: "Style Guide",
-                href: "https://github.com/securecodebox/docusaurus#style-guide",
+                href: "https://github.com/securecodebox/securecodebox/documentation/#style-guide",
               },
               {
                 label: "Icons",
@@ -133,7 +136,7 @@ module.exports = {
       ({
         docs: {
           sidebarPath: require.resolve("./sidebars.json"),
-          editUrl: "https://github.com/securecodebox/docusaurus/edit/main/",
+          editUrl: "https://github.com/securecodebox/securecodebox/edit/main/documentation/",
           lastVersion: "current",
           exclude: ["telemetry.md", "architecture/09_architecture_decisions/adr_0000.md", "architecture/09_architecture_decisions/adr_README.md"],
           versions: {
@@ -147,7 +150,7 @@ module.exports = {
           blogTitle: 'Blog on Automated Security Testing',
           blogDescription: 'In this blog the core maintainer will write about the development, roadmap, ideas RFCs etc. of the OWASP secureCodeBox.',
           showReadingTime: true,
-          editUrl: "https://github.com/securecodebox/docusaurus/edit/main/",
+          editUrl: "https://github.com/securecodebox/securecodebox/edit/main/documentation/",
           feedOptions: {
             type: "all",
             title: "The secureCodeBox Developer Blog",

diff --git a/documentation/src/docs.build.js b/documentation/src/docs.build.js
@@ -114,7 +114,7 @@ async function createDocFilesFromMainRepository(relPath, targetPath, dirNames) {
 
     // Add a custom editUrl to the frontMatter to ensure that it points to the correct repo
     const { data: frontmatter, content } = matter(readmeContent);
-    const filePathInRepo = relPath.replace(/^githubRepo\//, "");
+    const filePathInRepo = relPath.replace(/^.*secureCodeBox\//, "");
     const readmeWithEditUrl = matter.stringify(content, {
       ...frontmatter,
       description: frontmatter?.usecase,

diff --git a/documentation/src/utils/config.js b/documentation/src/utils/config.js
@@ -7,7 +7,8 @@ const docsConfig = {
     targetPath: "docs", // This needs to be 'docs' for the docusaurus build, but you may specify a 'docs/<subdirectory>'
     sizeLimit: 500000, // Limit of file size, most importantly used for large findings.
     findingsDir: "findings", // Directory for large findings which exceeded sizeLimit
-
+    branch: "main",
+
     // Configures files which will be copied or generated from docsConfig.repository.
     // This is an array of maps.
     //

diff --git a/documentation/static/img/Og_image.png b/documentation/static/img/Og_image.png
diff --git a/documentation/static/img/Og_image.png.license b/documentation/static/img/Og_image.png.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: the secureCodeBox authors
+
+SPDX-License-Identifier: Apache-2.0
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		SPDX-FileCopyrightText: the secureCodeBox authors

		SPDX-License-Identifier: Apache-2.0