Fixed DevContainer Issue + github cli + Updated Documentation + Pre-build docker image#198
Conversation
…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.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@mattaereal plz review |
oops
- 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
left a comment
There was a problem hiding this comment.
Left a comment about the image!
… streamlined setup
|
I just tested the guide using VSCode on a Mac, and it works amazingly well! A couple of notes on some issues I encountered:
for the rest, it's perfect!!!! |
- 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.
|
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 |
|
if it good we can approve and merge it! |
…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.
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:
closes #190
src/config/SUMMARY.developand notsrc/SUMMARY.md