frameworks-volunteer
diff --git a/‎.devcontainer/Dockerfile‎
Lines changed: 39 additions & 0 deletions b/‎.devcontainer/Dockerfile‎
Lines changed: 39 additions & 0 deletions
diff --git a/‎.devcontainer/devcontainer.json‎
Lines changed: 30 additions & 0 deletions b/‎.devcontainer/devcontainer.json‎
Lines changed: 30 additions & 0 deletions
diff --git a/‎.github/PULL_REQUEST_TEMPLATE.md‎
Lines changed: 8 additions & 16 deletions b/‎.github/PULL_REQUEST_TEMPLATE.md‎
Lines changed: 8 additions & 16 deletions
diff --git a/‎.github/workflows/md-lint.yaml‎
Lines changed: 1 addition & 1 deletion b/‎.github/workflows/md-lint.yaml‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎.github/workflows/spell-check.yml‎
Lines changed: 0 additions & 2 deletions b/‎.github/workflows/spell-check.yml‎
Lines changed: 0 additions & 2 deletions
diff --git a/‎.gitignore‎
Lines changed: 12 additions & 0 deletions b/‎.gitignore‎
Lines changed: 12 additions & 0 deletions
diff --git a/‎README.md‎
Lines changed: 72 additions & 37 deletions b/‎README.md‎
Lines changed: 72 additions & 37 deletions
diff --git a/‎justfile‎
Lines changed: 20 additions & 0 deletions b/‎justfile‎
Lines changed: 20 additions & 0 deletions
diff --git a/‎serve.sh‎
Lines changed: 0 additions & 8 deletions b/‎serve.sh‎
Lines changed: 0 additions & 8 deletions
diff --git a/‎src/README.md‎
Lines changed: 0 additions & 50 deletions b/‎src/README.md‎
Lines changed: 0 additions & 50 deletions
@@ -0,0 +1,39 @@
+# Base debian build with VS Code devcontainer base
+FROM mcr.microsoft.com/vscode/devcontainers/base:debian
+
+# Update packages and install only essential dependencies
+RUN apt-get update && apt-get install -y \
+    build-essential \
+    pkg-config \
+    libssl-dev \
+    aspell \
+    aspell-en \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+# Switch to vscode user
+USER vscode
+
+# Install Rust and Cargo for vscode user
+RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+ENV PATH="/home/vscode/.cargo/bin:${PATH}"
+
+# Install mdBook and mdbook-admonish
+RUN /home/vscode/.cargo/bin/cargo install mdbook mdbook-admonish
+
+# Install just command runner
+RUN /home/vscode/.cargo/bin/cargo install just
+
+# Copy markdownlint-cli2 from its Docker image (need root for this)
+USER root
+COPY --from=davidanson/markdownlint-cli2:latest /usr/local/bin/markdownlint-cli2 /usr/local/bin/markdownlint-cli2
+RUN chmod +x /usr/local/bin/markdownlint-cli2
+
+# Switch back to vscode user
+USER vscode
+
+# Set working directory
+WORKDIR /workspace
+
+# Ensure cargo is in PATH for vscode user
+RUN echo 'export PATH="/home/vscode/.cargo/bin:$PATH"' >> /home/vscode/.bashrc
@@ -0,0 +1,30 @@
+{
+    "name": "Security Frameworks DevContainer",
+    "build": {
+        "dockerfile": "Dockerfile"
+    },
+    "features": {},
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "yzhang.markdown-all-in-one",
+                "rust-lang.rust-analyzer",
+                "tamasfe.even-better-toml"
+            ],
+            "settings": {
+                "terminal.integrated.defaultProfile.linux": "bash",
+                "terminal.integrated.profiles.linux": {
+                    "bash": {
+                        "path": "/bin/bash"
+                    }
+                }
+            }
+        }
+    },
+    "forwardPorts": [
+        3000
+    ],
+    "workspaceMount": "source=${localWorkspaceFolder},target=/workspace,type=bind,consistency=cached",
+    "workspaceFolder": "/workspace",
+    "postCreateCommand": "echo 'DevContainer ready! Run \"just serve\" to start the mdBook server.'"
+}
@@ -1,26 +1,18 @@
 ## Frameworks PR Checklist
 
-Thank you for contributing to the Security Frameworks! Before you open a PR, make sure to read [information for contributors](https://framework.securityalliance.org/book/contribute/contribute.html) and take a look at the following checklist:
+Thank you for contributing to the Security Frameworks! Before you open a PR, make sure to read [information for contributors](https://frameworks.securityalliance.dev/contribute/contributing.html) and take a look at the following checklist:
 
 - [ ] Describe your changes, substitute this text with the information
-- [ ] If you are touching an existing piece of content, ask the original creator for review
-- [ ] If you need feedback for your content from wider community, share the PR in our Discord
+- [ ] If you are touching an existing piece of content, tag current contributors from the attribution list
+- [ ] If there is a steward for that framework, ask the steward to review it
+- [ ] If you're modifying the general outline, make sure to use `src/config/SUMMARY.develop` and not `src/SUMMARY.md`
+- [ ] If you need feedback for your content from the wider community, share the PR in our Discord
 - [ ] Review changes to ensure there are no typos, see instructions below
 
 <!--
 ℹ️ Checking for typos locally
 1. Install [aspell](https://www.gnu.org/software/aspell/) for your platform.
-2. Navigate to the project root and run:
-```
- for f in **/*.md ; do echo $f ; aspell --lang=en_US --mode=markdown --home-dir=. --personal=wordlist.txt --ignore-case=true --camel-case list  < $f | sort | uniq -c ; done
-```
-
-ℹ️ Fixing typos
-1. Fix typos: Open the relevant files and fix any identified typos.
-2. Update wordlist: If a flagged word is actually a project-specific term add it to `wordlist.txt` in the project root.
-   Each word should be listed on a separate line.
- * 🚧 Remember:
-    * When adding new words it must NOT have any spaces or special characters within or around it.
-    * \`wordlist\` is NOT case sensitive.
-    * Use backticks to quote code variables so as to not bloat the \`wordlist\`.
+2. Install [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2)
+3. Install [just](https://github.com/casey/just)
+4. Run `just lint`
 -->
@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    - uses: DavidAnson/markdownlint-cli2-action@v15
+    - uses: DavidAnson/markdownlint-cli2-action@v20
       continue-on-error: true
       with:
         globs: |
 
@@ -4,8 +4,6 @@ on:
   pull_request:
     branches:
       - main
-      - develop
-
 jobs:
   typo_check:
     name: 🥢 Spell check
 
@@ -19,3 +19,15 @@ Cargo.lock
 # Ignore contributors index file to prevent watch loops
 theme/contributors/contributorsindex.js
 theme/tags/tagsindex.js
+
+# Ignore claude-code installation
+claude-code
+@anthropic-ai/claude-code
+
+# Node.js dependencies
+node_modules/
+package.json
+package-lock.json
+
+# Claude Code configuration
+CLAUDE.md
@@ -1,28 +1,54 @@
 # Security Frameworks content repository
 
-Official repository to the Security Frameworks by SEAL. This repository contains the entire
-structure and contents of the frameworks. Feel free to suggest from new categories to grammar
-corrections. Collaboration is open to everyone. **This is a work in progress.**
+Official repository to the Security Frameworks by SEAL. This repository contains the entire structure and contents of the frameworks. Feel free to suggest from new categories to grammar corrections. Collaboration is open to everyone. **This is a work in progress.**
 
-If you want to know more about the frameworks or take a peek at the live book go to the following
-branches below: [Main](https://seal-frameworks.vercel.app/),
-[Development](https://frameworks-git-develop-seal-frameworks.vercel.app/?_vercel_share=zOI0Q3riUfDv1Lq1IylFz2hXQzYPcmLp).
+If you want to know more about the frameworks or take a peek at the live book go to the following branches: [Main](frameworks.securityalliance.org), [Development](frameworks.securityalliance.dev).
 
-Production will be at [frameworks.securityalliance.org](https://frameworks.securityalliance.org),
-but not yet available.
+# Prerequisites
+
+- [Rust/cargo](https://www.rust-lang.org/tools/install) (For building/serving mdBook)
+- [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) (For linting markdown files)
+- [GNU Aspell](https://sourceforge.net/projects/aspell/) (For spell checking)
+- [just](https://github.com/casey/just) (For running commands)
 
 ## Quick installation and local setup
 
 1. `gh repo clone security-alliance/frameworks`
 2. `git checkout develop`
-3. `cargo install mdbook mdbook-admonish mdbook-catppuccin`
-4. `./serve.sh`
+3. `just serve`
 
 ## Collaboration
 
-There are currently two ways to collaborate. The first one is by logging from your Vercel account
-and commenting directly on the deployed version of the book, and the second one is by forking the
-repository and creating a pull request.
+There are currently several ways to collaborate:
+
+1. Using the "Suggest an edit" button on any page to make quick edits
+2. Contributing to a specific framework through its dedicated branch
+3. Forking the repository and creating a pull request to the develop branch
+4. Commenting directly on the deployed version
+
+> ⚠️ Please sign and verify every commit. If you've accidentally created unsigned
+> commits in your history, you can resolve them by setting up [signature verification](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification#gpg-commit-signature-verification)
+> on github and re-writing your history using the below commands.
+>
+> ```
+> git pull origin develop
+> git reset --soft develop
+> git commit -s -m "Commit Message"
+> git push --force
+> ```
+
+### Framework-specific branches
+
+Before contributing, check if there's a [Steward](https://frameworks.securityalliance.dev/contribute/contributors.html#stewards) for the specific framework you're interested in, and reach out. We usually have separate branches pre-develop for frameworks with stewards.
+
+The naming convention is `fw_framework_name`, for example `fw_opsec`, `fw_community_mgmt`. Ideally, you'll fork these framework-specific branches, as they typically have more updated information than what's available in the develop branch.
+
+After making your changes:
+1. Run the linting command `just lint`
+2. Submit a PR to the framework-specific branch and let the steward know
+3. After reviews, a PR can be submitted from the framework branch to the develop branch
+
+If there's no specific branch created, that framework is still "headless," which means you can become its steward! See more in the [Stewards](src/contribute/stewards.md) section.
 
 ### Comments
 
@@ -32,26 +58,38 @@ To comment on the live version of the book under development, you will need to l
 
 1. Fork the repository. Click on the "Fork" button at the top right corner of the page.
 2. Clone the forked repository to your local machine. Open your terminal or command prompt.
-`git clone https://github.com/your-username/frameworks.git`
-3. Make sure you're in the develop branch first.
-`git checkout develop`
-4. Inside the folder create a new branch based on `develop`.
-`git checkout -b develop`
-5. Make your changes.
-6. Make sure your changes don't break anything by testing it in the local setup (see above).
-`./serve.sh`.
-7. Commit your changes.
-`git add .`
-8. Commit the changes with a descriptive message:
-`git commit -m "Fixing typos and improving readability on XXX section"`
-9. Push the changes to your forked repository.
-`git push origin develop`
-10. Create a pull request. Go to your forked repository on GitHub. You should see a "Compare & pull
-   request" button. Click on it. Provide a descriptive title and description for your pull request.
-11. Click on the "Create pull request" button.
-12. Wait for review. Once your pull request is approved, and no more changes are needed, we will
-    merge it into the main repository.
-13. Congratulations! Your changes are now part of the security frameworks!
+   `git clone https://github.com/your-username/frameworks.git`
+3. Check if there's a framework-specific branch you should be working on. If yes, use that branch instead of develop.
+4. Otherwise, make sure you're in the develop branch:
+   `git checkout develop`
+5. Inside the folder create a new branch based on the appropriate branch:
+   `git checkout -b your-feature-branch`
+6. Make your changes.
+7. If adding new pages, consider adding appropriate tags in the frontmatter. Example:
+
+```
+---
+tags:
+  - Engineer/Developer
+  - Security Specialist
+  - Devops
+  - SRE
+---
+```
+
+8. If adding significant content, add attribution using the contributors system (see [using-contributors.md](src/config/using-contributors.md)).
+9. Make sure your changes don't break anything by testing it in the local setup:
+   `just serve`
+10. Commit your changes:
+    `git add .`
+11. Commit the changes with a descriptive message:
+    `git commit -S -m "Fixing typos and improving readability on XXX section"`
+12. Push the changes to your forked repository:
+    `git push origin your-feature-branch`
+13. Create a pull request. Go to your forked repository on GitHub. You should see a "Compare & pull request" button. Click on it. Provide a descriptive title and description for your pull request.
+14. Click on the "Create pull request" button.
+15. Wait for review. Once your pull request is approved, and no more changes are needed, we will merge it into the appropriate branch.
+16. Congratulations! Your changes are now part of the security frameworks!
 
 ## Editor area
 
@@ -60,7 +98,4 @@ Editors merge PRs and push suggestions to the main branch which will be reflecte
 1. `git checkout main`
 2. `git fetch origin develop`
 3. `git merge origin/develop`
-4. Manually merge files, solve conflicts and add a description.
-
-- Using the `serve.sh` script instead of mdBook `serve` command is needed to be able to see properly
-  the local deployment.
+4. Manually merge files, solve conflicts and add a description.
@@ -0,0 +1,20 @@
+# Default recipe to display help information
+default:
+    @just --list
+
+# Install dependencies
+install:
+    cargo install mdbook mdbook-admonish
+
+# Serve the book locally with hot reload
+serve: install
+    mdbook serve --hostname 0.0.0.0
+
+# Run all linting checks
+lint:
+    @echo "Running spell check..."
+    @for f in **/*.md ; do echo $f ; aspell --lang=en_US --mode=markdown --home-dir=. --personal=wordlist.txt --ignore-case=true --camel-case list  < $f | sort | uniq -c ; done
+    @echo "Spell check complete!"
+    @echo ""
+    @echo "Running markdownlint..."
+    markdownlint-cli2 ./src/*.md