Skip to content

docs: Add Security Best Practices #622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: Add Security Best Practices #622

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a568935
review
calldelegation Mar 6, 2025
400651c
ready for kyran to update submodule
calldelegation Mar 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .gitmodules
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions contentlayer.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand All @@ -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',
Expand All @@ -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',
Expand All @@ -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',
Expand Down
1 change: 1 addition & 0 deletions docs/nightly/security-best-practices
Open in desktop
Submodule security-best-practices added at f29cea
1 change: 1 addition & 0 deletions docs/security-best-practices
Open in desktop
Submodule security-best-practices added at f29cea
3 changes: 3 additions & 0 deletions scripts/clean-build-files.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down Expand Up @@ -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'],
Expand Down
16 changes: 16 additions & 0 deletions scripts/generate-links/getDocs.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions scripts/generate-links/getOrders.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
4 changes: 4 additions & 0 deletions scripts/generate-links/index.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,9 @@ function getSidebarName(key) {
case 'node-operator':
newKey = 'Node Operator';
break;
case 'security-best-practices':
newKey = 'Security Best Practices';
break;
default:
}

Expand All @@ -132,6 +135,7 @@ function handleAllOrders(allOrders, folderPath, filename) {
'fuel-token-overview',
'verified-addresses',
'node-operator',
'security-best-practices',
'guides',
'sway',
'sway-libs',
Expand Down
3 changes: 3 additions & 0 deletions src/components/SidebarSection.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down
9 changes: 9 additions & 0 deletions src/config/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
4 changes: 3 additions & 1 deletion src/lib/md-doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
Loading