Skip to content

Commit d39751e

Browse files
IlyesbdlalaWeltraumschaf
authored andcommitted
#1964 Fixed edit url of documentation to link correctly to the securecodebox monorepo
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
1 parent dff842d commit d39751e

3 files changed

Lines changed: 6 additions & 5 deletions

File tree

documentation/docusaurus.config.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ module.exports = {
7676
items: [
7777
{
7878
label: "Style Guide",
79-
href: "https://github.com/securecodebox/docusaurus#style-guide",
79+
href: "https://github.com/securecodebox/securecodebox/documentation/#style-guide",
8080
},
8181
{
8282
label: "Icons",
@@ -136,7 +136,7 @@ module.exports = {
136136
({
137137
docs: {
138138
sidebarPath: require.resolve("./sidebars.json"),
139-
editUrl: "https://github.com/securecodebox/docusaurus/edit/main/",
139+
editUrl: "https://github.com/securecodebox/securecodebox/edit/main/documentation/",
140140
lastVersion: "current",
141141
exclude: ["telemetry.md", "architecture/09_architecture_decisions/adr_0000.md", "architecture/09_architecture_decisions/adr_README.md"],
142142
versions: {
@@ -150,7 +150,7 @@ module.exports = {
150150
blogTitle: 'Blog on Automated Security Testing',
151151
blogDescription: 'In this blog the core maintainer will write about the development, roadmap, ideas RFCs etc. of the OWASP secureCodeBox.',
152152
showReadingTime: true,
153-
editUrl: "https://github.com/securecodebox/docusaurus/edit/main/",
153+
editUrl: "https://github.com/securecodebox/securecodebox/edit/main/documentation/",
154154
feedOptions: {
155155
type: "all",
156156
title: "The secureCodeBox Developer Blog",

documentation/src/docs.build.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ async function createDocFilesFromMainRepository(relPath, targetPath, dirNames) {
114114

115115
// Add a custom editUrl to the frontMatter to ensure that it points to the correct repo
116116
const { data: frontmatter, content } = matter(readmeContent);
117-
const filePathInRepo = relPath.replace(/^githubRepo\//, "");
117+
const filePathInRepo = relPath.replace(/^.*secureCodeBox\//, "");
118118
const readmeWithEditUrl = matter.stringify(content, {
119119
...frontmatter,
120120
description: frontmatter?.usecase,

documentation/src/utils/config.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ const docsConfig = {
77
targetPath: "docs", // This needs to be 'docs' for the docusaurus build, but you may specify a 'docs/<subdirectory>'
88
sizeLimit: 500000, // Limit of file size, most importantly used for large findings.
99
findingsDir: "findings", // Directory for large findings which exceeded sizeLimit
10-
10+
branch: "main",
11+
1112
// Configures files which will be copied or generated from docsConfig.repository.
1213
// This is an array of maps.
1314
//

0 commit comments

Comments
 (0)