Skip to content

Fixed DevContainer Issue + github cli + Updated Documentation + Pre-build docker image#198

Merged
mattaereal merged 13 commits into
security-alliance:developfrom
DicksonWu654:devcontainer
Aug 18, 2025
Merged

Fixed DevContainer Issue + github cli + Updated Documentation + Pre-build docker image#198
mattaereal merged 13 commits into
security-alliance:developfrom
DicksonWu654:devcontainer

Conversation

@DicksonWu654

@DicksonWu654 DicksonWu654 commented Aug 9, 2025

Copy link
Copy Markdown
Collaborator

Frameworks PR Checklist

Thank you for contributing to the Security Frameworks! Before you open a PR, make sure to read information for contributors and take a look at the following checklist:

  • Fixed just lint failing - upgraded to Node.js 20.x LTS and proper markdownlint-cli2 installation
  • Added GitHub CLI integration - automatic gh CLI with VS Code authentication support
  • Enhanced contributor setup instructions in README.md and contributing.md
  • Pre-building the docker image used in the .devcontainer so it doesn't take 180 seconds to build. Now it's basically instant. I uploaded it on my personal docker account: shadow654/frameworks-devcontainer:latest

closes #190

  • 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

…oring before node was not installed but now fixed to install and just lint works now

Update Dockerfile to install Node.js 20.x and markdownlint-cli2 globally via npm

- Added installation of Node.js 20.x from NodeSource.
- Replaced the previous method of copying markdownlint-cli2 from a Docker image with a global npm installation.
… instructions

- Added a recommended DevContainer setup option in README.md for easier local development.
- Updated contributing.md to include detailed steps for using DevContainer, emphasizing its benefits for contributors.
- Clarified local installation steps for both DevContainer and manual setup.
- Added GitHub CLI feature to the devcontainer for easier GitHub interactions.
- Enhanced contributing.md with clearer instructions and an optional step for authenticating with GitHub CLI, improving the onboarding experience for new contributors.
@vercel

vercel Bot commented Aug 9, 2025

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Project Deployment Preview Comments Updated (UTC)
frameworks Ready Preview Comment Aug 14, 2025 4:04am

@DicksonWu654 DicksonWu654 changed the title Fixed DevContainer Issue + github cli + Updated Documentation Fixed DevContainer Issue + github cli + Updated Documentation + Pre-build docker image Aug 9, 2025
@DicksonWu654

Copy link
Copy Markdown
Collaborator Author

@mattaereal plz review

- Updated README.md to include Docker as an optional tool for running the devcontainer.
- Expanded contributing.md with detailed instructions for using DevContainer with and without VSCode, including steps for using the DevContainer CLI.
- Clarified local installation prerequisites and steps for contributors.
instead added instructions on how to access it from the container's IP
@mattaereal mattaereal requested a review from scode2277 August 11, 2025 15:22
@mattaereal mattaereal added the local setup Improvements or additions to the local setup label Aug 11, 2025
@mattaereal mattaereal self-requested a review August 11, 2025 19:47

@mattaereal mattaereal left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a comment about the image!

Comment thread .devcontainer/devcontainer.json Outdated
@scode2277

Copy link
Copy Markdown
Collaborator

I just tested the guide using VSCode on a Mac, and it works amazingly well!

A couple of notes on some issues I encountered:

  • Aspell: The official download page doesn’t provide a straightforward macOS installer. The easiest way to install Aspell on Mac is via Homebrew:
    brew install aspell

  • GitHub CLI (gh): To run the first command (gh repo clone security-alliance/frameworks), users need to have the GitHub CLI installed and authenticated. On Mac, you can install it with Homebrew:

brew install gh
After installing, gh auth login to authenticate.

for the rest, it's perfect!!!!

Comment thread README.md Outdated
Comment thread README.md
- Updated README.md to include installation instructions for GNU Aspell via Homebrew on macOS and added GitHub CLI as an optional tool.
- Revised contributing.md to clarify development environment setup options, including a new section for local installation with detailed prerequisites and setup steps.
@DicksonWu654

Copy link
Copy Markdown
Collaborator Author

Updated now! @mattaereal @scode2277 wdyt of the readme being a bit bigger now to take into account the setup stuff? We could tell them to go to src/contribute/contributing.md

@DicksonWu654

Copy link
Copy Markdown
Collaborator Author

if it good we can approve and merge it!

@mattaereal mattaereal merged commit f9efc46 into security-alliance:develop Aug 18, 2025
3 checks passed
@DicksonWu654 DicksonWu654 deleted the devcontainer branch February 9, 2026 21:04
frameworks-volunteer pushed a commit to frameworks-volunteer/frameworks that referenced this pull request Mar 9, 2026
…uild docker image (security-alliance#198)

* Fixing .devcontainer's dockerfile's just lint to work. Before was erroring before node was not installed but now fixed to install and just lint works now

Update Dockerfile to install Node.js 20.x and markdownlint-cli2 globally via npm

- Added installation of Node.js 20.x from NodeSource.
- Replaced the previous method of copying markdownlint-cli2 from a Docker image with a global npm installation.

* Enhance README and contributing documentation with DevContainer setup instructions

- Added a recommended DevContainer setup option in README.md for easier local development.
- Updated contributing.md to include detailed steps for using DevContainer, emphasizing its benefits for contributors.
- Clarified local installation steps for both DevContainer and manual setup.

* joe

* Update devcontainer configuration and contributing documentation

- Added GitHub CLI feature to the devcontainer for easier GitHub interactions.
- Enhanced contributing.md with clearer instructions and an optional step for authenticating with GitHub CLI, improving the onboarding experience for new contributors.

* Update devcontainer configuration to specify Docker image for improved setup

* Delete joe

oops

* Enhance documentation for DevContainer setup and local development

- Updated README.md to include Docker as an optional tool for running the devcontainer.
- Expanded contributing.md with detailed instructions for using DevContainer with and without VSCode, including steps for using the DevContainer CLI.
- Clarified local installation prerequisites and steps for contributors.

* fixing devcontainer cli

* Removing the port forwarding cause dangerous

instead added instructions on how to access it from the container's IP

* Remove integration mapping documentation file

* Remove Docker image specification from devcontainer configuration for streamlined setup

* Enhance documentation for development environment setup

- Updated README.md to include installation instructions for GNU Aspell via Homebrew on macOS and added GitHub CLI as an optional tool.
- Revised contributing.md to clarify development environment setup options, including a new section for local installation with detailed prerequisites and setup steps.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

local setup Improvements or additions to the local setup

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add docs for using Devcontainer

3 participants