Skip to content

Contribution Guidelines ​

You don't need to be an expert coder to contribute to this project. We want everyone to participate in this architectural discussion.

For Non-Coders (Markdown Submission) ​

If you just want to suggest changes to the architecture, policies, or guidelines, you don't need to know how to code.

  1. Open any .md file in the project (e.g., README.md, architecture/01_enterprise_topology.md, etc.).
  2. Click the Edit (pencil icon) button on GitHub to edit the file.
  3. Once you're done, submit a Pull Request (PR) using the Propose changes option at the bottom.
  4. Our admins will review and merge your changes, and the site will be updated automatically!

For Coders (Website and Automation) ​

If you want to contribute to the landing page (VitePress) or its theme/plugins:

  1. Fork the repository and clone it to your local machine.
  2. Run npm install to install the dependencies.
  3. Run npm run docs:dev to start the development server.
  4. Make your changes (in .vitepress/ or other folders) and submit a PR.

Discussion Portal ​

If you have any questions about architectural decisions, feel free to visit the GitHub Discussions tab directly or leave your thoughts in the comment box (Giscus) at the bottom of the website pages.

Released under the MIT License.