diff --git a/.gitmodules b/.gitmodules index 6ac1fa4c..93e199d8 100644 --- a/.gitmodules +++ b/.gitmodules @@ -119,3 +119,9 @@ [submodule "docs/nightly/node-operator"] path = docs/nightly/node-operator url = https://github.com/FuelLabs/node-operator.git +[submodule "docs/security-best-practices"] + path = docs/security-best-practices + url = https://github.com/FuelLabs/security-best-practices +[submodule "docs/nightly/security-best-practices"] + path = docs/nightly/security-best-practices + url = https://github.com/FuelLabs/security-best-practices diff --git a/.vscode/settings.json b/.vscode/settings.json index e4dd10ec..a16271d3 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -25,6 +25,7 @@ "**/sway-by-example-lib": true, "**/migrations-and-disclosures": true, "**/fuel-book": true, + "**/security-best-practices": true, "**/verified-addresses": true, "**/fuel-token-overview": true, "**/node-operator": true diff --git a/contentlayer.config.ts b/contentlayer.config.ts index 25ac17b0..c735003b 100644 --- a/contentlayer.config.ts +++ b/contentlayer.config.ts @@ -66,6 +66,7 @@ const includeDirs = [ 'docs/sway-by-example-lib/docs/src', 'docs/migrations-and-disclosures/docs/src', 'docs/fuel-book/docs/src', + 'docs/security-best-practices/docs/src', 'docs/verified-addresses/docs/src', 'docs/fuel-token-overview/docs/src', 'docs/integration-docs/docs/src', @@ -82,6 +83,7 @@ const includeDirs = [ 'docs/nightly/sway-by-example-lib/docs/src', 'docs/nightly/migrations-and-disclosures/docs/src', 'docs/nightly/fuel-book/docs/src', + 'docs/nightly/security-best-practices/docs/src', 'docs/nightly/verified-addresses/docs/src', 'docs/nightly/fuel-token-overview/docs/src', 'docs/nightly/integration-docs/docs/src', @@ -102,6 +104,7 @@ const excludeDirs = [ 'docs/sway-by-example-lib/docs/src/SUMMARY.md', 'docs/migrations-and-disclosures/docs/src/SUMMARY.md', 'docs/fuel-book/docs/src/SUMMARY.md', + 'docs/security-best-practices/docs/src/SUMMARY.md', 'docs/verified-addresses/docs/src/SUMMARY.md', 'docs/fuel-token-overview/docs/src/SUMMARY.md', 'docs/integration-docs/docs/src/SUMMARY.md', @@ -115,6 +118,7 @@ const excludeDirs = [ 'docs/nightly/sway-by-example-lib/docs/src/SUMMARY.md', 'docs/nightly/migrations-and-disclosures/docs/src/SUMMARY.md', 'docs/nightly/fuel-book/docs/src/SUMMARY.md', + 'docs/nightly/security-best-practices/docs/src/SUMMARY.md', 'docs/nightly/verified-addresses/docs/src/SUMMARY.md', 'docs/nightly/fuel-token-overview/docs/src/SUMMARY.md', 'docs/nightly/integration-docs/docs/src/SUMMARY.md', diff --git a/docs/nightly/security-best-practices b/docs/nightly/security-best-practices new file mode 160000 index 00000000..f29ceae6 --- /dev/null +++ b/docs/nightly/security-best-practices @@ -0,0 +1 @@ +Subproject commit f29ceae64bd2083d2fb7072f8cadc98c68450de0 diff --git a/docs/security-best-practices b/docs/security-best-practices new file mode 160000 index 00000000..f29ceae6 --- /dev/null +++ b/docs/security-best-practices @@ -0,0 +1 @@ +Subproject commit f29ceae64bd2083d2fb7072f8cadc98c68450de0 diff --git a/scripts/clean-build-files.mjs b/scripts/clean-build-files.mjs index 2c26b442..6c9dd8f6 100644 --- a/scripts/clean-build-files.mjs +++ b/scripts/clean-build-files.mjs @@ -26,6 +26,8 @@ const targetDirs = [ './docs/nightly/migrations-and-disclosures', './docs/fuel-book', './docs/nightly/fuel-book', + './docs/security-best-practices', + './docs/nightly/security-best-practices', './docs/verified-addresses', './docs/nightly/verified-addresses', './docs/fuel-token-overview', @@ -80,6 +82,7 @@ const exclusions = { ], migrations_and_disclosures: ['migrations-and-disclosures/docs'], fuel_book: ['fuel-book/docs'], + security_best_practices: ['security-best-practices/docs'], verified_addresses: ['verified-addresses/docs'], fuel_token_overview: ['fuel-token-overview/docs'], integration_docs: ['integration-docs/docs'], diff --git a/scripts/generate-links/getDocs.mjs b/scripts/generate-links/getDocs.mjs index c7e85a63..212b2a2d 100644 --- a/scripts/generate-links/getDocs.mjs +++ b/scripts/generate-links/getDocs.mjs @@ -154,6 +154,22 @@ export async function getDocs(key, order) { '!**/SUMMARY.md', ]; break; + case 'security-best-practices': + paths = [ + './security-best-practices/docs/src/*.md', + './security-best-practices/docs/src/**/*.md', + // IGNORE ALL SUMMARY PAGES + '!**/SUMMARY.md', + ]; + break; + case 'nightly-security-best-practices': + paths = [ + './nightly/security-best-practices/docs/src/*.md', + './nightly/security-best-practices/docs/src/**/*.md', + // IGNORE ALL SUMMARY PAGES + '!**/SUMMARY.md', + ]; + break; case 'integration-docs': paths = [ // INTEGRATION DOCS diff --git a/scripts/generate-links/getOrders.mjs b/scripts/generate-links/getOrders.mjs index b5e1c018..7aab00ce 100644 --- a/scripts/generate-links/getOrders.mjs +++ b/scripts/generate-links/getOrders.mjs @@ -17,6 +17,10 @@ const CONFIG = { type: 'mdbook', path: './node-operator/docs/src/SUMMARY.md', }, + 'security-best-practices': { + type: 'mdbook', + path: './security-best-practices/docs/src/SUMMARY.md', + }, 'integration-docs': { type: 'mdbook', path: './integration-docs/docs/src/SUMMARY.md', diff --git a/scripts/generate-links/index.mjs b/scripts/generate-links/index.mjs index ac8db612..4e4b23a0 100644 --- a/scripts/generate-links/index.mjs +++ b/scripts/generate-links/index.mjs @@ -118,6 +118,9 @@ function getSidebarName(key) { case 'node-operator': newKey = 'Node Operator'; break; + case 'security-best-practices': + newKey = 'Security Best Practices'; + break; default: } @@ -132,6 +135,7 @@ function handleAllOrders(allOrders, folderPath, filename) { 'fuel-token-overview', 'verified-addresses', 'node-operator', + 'security-best-practices', 'guides', 'sway', 'sway-libs', diff --git a/src/components/SidebarSection.tsx b/src/components/SidebarSection.tsx index 72b1e1a5..3c6ac44b 100644 --- a/src/components/SidebarSection.tsx +++ b/src/components/SidebarSection.tsx @@ -76,6 +76,9 @@ export function SidebarSection({ case 'Node-Operator': githubLink = 'https://github.com/FuelLabs/node-operator'; break; + case 'Security-best-practices': + githubLink = 'https://github.com/FuelLabs/security-best-practices'; + break; default: break; } diff --git a/src/config/docs.json b/src/config/docs.json index c1938f4f..6de36b4c 100644 --- a/src/config/docs.json +++ b/src/config/docs.json @@ -26,6 +26,15 @@ "image": "" } }, + "security-best-practices": { + "title": "Security Best Practices", + "slug": "security-best-practices", + "repository": "https://github.com/FuelLabs/security-best-practices", + "ogTags": { + "description": "Security Best Practices", + "image": "" + } + }, "integration-docs": { "title": "Integrations", "slug": "integration-docs", diff --git a/src/lib/md-doc.ts b/src/lib/md-doc.ts index 42bbec79..d541a469 100644 --- a/src/lib/md-doc.ts +++ b/src/lib/md-doc.ts @@ -75,7 +75,9 @@ export class Doc { .replace('docs/verified-addresses/', '') .replace('docs/fuel-token-overview/', '') .replace('docs/fuel-specs/', '') - .replace('docs/node-operator/', '')}`; + .replace('docs/node-operator/', '') + .replace('docs/security-best-practices/', '') + }`; let pageLink = `${config.repository}${actualPath.replace( 'tree/master/docs/sway-libs/docs',