diff --git a/.github/OTHER/entities.svg b/.github/OTHER/entities.svg deleted file mode 100644 index 050fc07..0000000 --- a/.github/OTHER/entities.svg +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - ProjectsGitHubOrganizationsGitHubRepositories \ No newline at end of file diff --git a/.github/OTHER/projects.svg b/.github/OTHER/projects.svg deleted file mode 100644 index 29c1e77..0000000 --- a/.github/OTHER/projects.svg +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - visionBoardWebsiteDatabase \ No newline at end of file diff --git a/.github/OTHER/visionBoard_architecture.svg b/.github/OTHER/visionBoard_architecture.svg deleted file mode 100644 index e6f0ba2..0000000 --- a/.github/OTHER/visionBoard_architecture.svg +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - WebsiteDatabaseartifactsGithub ActionsProvidersImportersvisionBoard - WorkflowsExternalAPIsFormsdataChecksReportingScriptsCLIContainers \ No newline at end of file diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md index 2824452..ae84a4a 100644 --- a/ARCHITECTURE.md +++ b/ARCHITECTURE.md @@ -1,92 +1 @@ -# Architecture - -This project is part of the [openPathfinder](https://github.com/OpenPathfinder) initiative, and it is playing a key role. In this document, you can find more details on the project's architecture. - -## Context - -![A flowchart with "Database" (yellow) bidirectionally connected to "visionBoard" (green), which sends data to "Website" (blue) via a one-way arrow.](.github/OTHER/projects.svg) - -The [visionBoard](https://github.com/OpenPathfinder/visionBoard) project mission is to collect data from external sources, generate intelligence from that data, and store the information in a database (PostgreSQL). In simple terms, we run "checks" against the database to understand the health of the projects. - -Later, this data is used by other projects to showcase information to users (compliance checks, reports, etc.) in [the website](https://github.com/OpenPathfinder/website). You can find more details about the integration in [this pipeline](https://github.com/OpenPathfinder/website/blob/cec1882d60d62502aa07e43980b1133f0525c036/.github/workflows/sync_checks.yml#L41). - -## Entities - -![A flowchart showing "Projects" (blue) connected to "GitHub Organizations" (green), which links to "GitHub Repositories" (yellow) in both directions.](.github/OTHER/entities.svg) - -As this project originated as "the dashboard" for the OpenJS Foundation, we followed the same entities organization. Essentially, the foundation [has projects](https://openjsf.org/projects) that can lead to multiple GitHub Organizations, with several repositories in each. - -Most of the data enrichment is done against repositories or organizations, while the checks are performed against projects themselves and other tables. - -### Database Schemas - -You can find the SQL structure updated in [src/database/schema/schema.sql](src/database/schema/schema.sql) if you want to use an external program to view the database structure. - -## Internal Parts - -Let’s look inside the visionBoard. Essentially, we have a CLI tool that triggers actions such as pulling data from the GitHub API or running checks against the stored information in the database. - -### Diagram - -![A flowchart showing "Database," "CLI," "artifacts," and external inputs connecting to "visionBoard Workflows" (Providers, Importers, Reporting, Checks, Scripts), with outputs to "Website" via GitHub Actions.](.github/OTHER/visionBoard_architecture.svg) - -In this diagram, we can see that the CLI is the main way users interact with the tool (also via scripts using `npm`), and we use the database to retrieve and store information. - -Internally, we have providers, importers, reporting, checks, and scripts. These components are specialized to accomplish specific tasks. Each section has its own domain and capabilities, which are isolated from each other for better testing and composability. This allows us to reuse components across workflows. - -### Parts - -#### CLI - -We often refer to `workflows` and `checks`—terms used in the CLI to organize user actions. Ideally, a workflow abstracts certain steps, such as pulling data from an external source and updating the database. - -The workflows and CLI commands are defined in specific folders ([src/workflows](src/workflows) and [src/cli](src/cli)), and general instructions can be found in [the README.md](README.md#usage). - -#### Providers - -Providers are external entities we connect to in order to retrieve relevant data. The providers can be found in [src/providers](src/providers). - -One prominent integration is with the GitHub API, where we collect information about repositories, organizations, branches, etc. This integration is done using the HTTP API. - -We also retrieve information by running containers, as in the case of the OSSF Scorecard, where we use the official image to run our own analysis ([ref](https://github.com/OpenPathfinder/visionBoard/pull/62)). For this, we use the [child process](https://nodejs.org/api/child_process.html) core library. - -Regardless of whether the data comes from containers or APIs, we validate it to ensure quality before storing it in the database. The schemas can be found in [src/schemas](src/schemas). - -#### Importers - -While in development ([ref](https://github.com/OpenPathfinder/visionBoard/issues/56)), the main idea is to bulk upsert information about the projects. This information is "manually" added by the maintainers and human-curated before ingestion. This source of data also undergoes JSON Schema validation, with schemas located in [src/schemas](src/schemas). - -#### Scripts - -We have several [scripts](scripts) that can be executed as npm commands. These scripts support external integrations with other tools and primarily query and prepare information from the database. - -In the future, these scripts may extend to other tasks related to the project's developer experience (DevEx). - -#### Checks - -Checks, or compliance checks, are the core of this project. They analyze information from the database to answer questions like "Do all my repositories have branch protection enabled?" After a check is completed, its results, alerts, and tasks are added to the database. - -Checks do not collect information and aim to work independently, following principles similar to unit testing: -- **Fast**: They should not run containers or query external sources—only database information is used. -- **Isolated**: There should be no dependencies between checks. -- **Repeatable**: Running a check multiple times should yield the same results. -- **Self-validating**: No manual interaction is required. -- **Immutable**: The same input produces the same output. - -#### Reporting - -An ongoing initiative ([ref](https://github.com/OpenPathfinder/visionBoard/milestone/4)) aims to generate reports after checks are run. These reports will help maintainers and users understand the status and what actions to take. - -These reports may contain sensitive information (under discussion) and are considered artifacts. - -#### Database - -We use a PostgreSQL database. Detailed information about database management, including migrations and seeds, is in [the README.md](README.md#database-management). - -To interact with the database, we have a store ([src/store](src/store)) that provides all the methods for querying the database. - -For testing, we utilize resources such as [__fixtures__](__fixtures__) and [__utils__](__utils__). - -#### Artifacts - -This project’s responsibility is to generate artifacts that other tools can consume, not to showcase the information. Artifacts are generated in various formats (JSON, Markdown, HTML) and stored in the [output](output) directory, which is ignored in Git. +See the [Architecture Guide](https://openpathfinder.com/docs/visionBoard/architecture) in the website for more information. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9912157..ebc0728 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,190 +1 @@ -# Contributing to the Dashboard - -Contributions to the Dashboard include code, documentation, answering user questions, running the project's infrastructure, and advocating for all types of users. - -The project welcomes all contributions from anyone willing to work in good faith with other contributors and the community. No contribution is too small, and all contributions are valued. - -The project has an open governance model. Individuals making significant and valuable contributions are made committers and given commit-access to the project. - -## Contents - -* [Code of Conduct](#code-of-conduct) -* [Architecture](#architecture) -* [Issues](#issues) -* [Pull Requests](#pull-requests) -* [Current Initiatives](#current-initiatives) -* [Developer's Certificate of Origin 1.1](#developers-certificate-of-origin-11) - -## Code of Conduct - -The project has a [Code of Conduct](/CODE_OF_CONDUCT.md) to which all contributors must adhere. - - -## Architecture - -The project includes a [technical architecture guide](/ARCHITECTURE.md) that provides in-depth explanations of various concepts. - -## Issues - -You have several templates available: - -* [Asking for General Help](https://github.com/OpenPathfinder/visionBoard/issues/new?assignees=&labels=&projects=&template=other.md&title=) -* [Request a New Feature](https://github.com/OpenPathfinder/visionBoard/issues/new?assignees=&labels=feature-request&projects=&template=feature_request.md&title=) -* [Report a Bug](https://github.com/OpenPathfinder/visionBoard/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=%5BBUG%5D) -* [Other](https://github.com/OpenPathfinder/visionBoard/issues/new?assignees=&labels=&projects=&template=other.md&title=) - -## Pull Requests - -### Create a good PR in this project -Here are some recommendations for creating PRs in this project. - -Creating a high-quality Pull Request (PR) helps maintainers review your contribution efficiently and ensures it aligns with the project's standards. Follow these steps to make your PR outstanding: - -### 1. Understand the Project's Guidelines - -- **Read the [Contributing Guidelines](CONTRIBUTING.md):** Check for any specific requirements for this project. -- **Follow the [Code of Conduct](CODE_OF_CONDUCT.md):** Ensure respectful communication and behavior. - -### 2. Before You Start - -- **Create an Issue (if required):** Link your PR to an issue if it addresses a bug or feature request. -- **Sync with the Main Branch:** Update your fork or branch with the latest changes to avoid conflicts. -- **Focus Your Work:** Address one issue or feature per PR. -- **Ensure the Work Is Expected:** Avoid submitting a PR when there is an ongoing discussion on the topic, as this might require you to make significant changes. -- **Avoid Duplications:** Check open PRs to avoid duplications. - -### 3. Writing the Code - -- **Follow Coding Standards:** Use [Standard](https://standardjs.com/) and refer to [the linter commands](/README.md#linting) to resolve any issues. -- **Write Tests:** Add or update tests to cover your changes. Check [the testing section](/README.md#testing). -- **Keep Changes Minimal:** Avoid unrelated changes or large rewrites, as this will make your PR hard to review. We prefer many small PRs rather than one large PR. - -### 4. Writing the PR - -- **Descriptive Title:** Use a clear and concise title that summarizes the change. -- **Detailed Description:** Include the following in the description: - - **What:** Explain what the PR does. - - **Why:** Describe why the change is necessary. - - **How:** Summarize how you implemented the change. - - **Related Issue:** Link any relevant issues (e.g., `Closes #123`). -- **Screenshots/Logs (if applicable):** Provide evidence of your changes for visual or functional updates. - -### 5. Review Checklist - -Before submitting your PR: -- [ ] Code is linted and passes all style checks. -- [ ] Tests are added, updated, and pass. -- [ ] Documentation is updated (if applicable). -- [ ] The branch is up-to-date with the main branch. -- [ ] Commit messages are clear and follow the project's guidelines. - -### 6. Submit and Engage - -- **Submit the PR:** Push your branch and open the PR using the project's preferred platform (e.g., GitHub). -- **Review Automated Comments:** Pipelines in this project might auto-suggest changes or additional steps based on the submitted changes. Please review them. -- **Check CI Results:** This project includes a CI pipeline that will check your PR for linting, tests, migrations, and more. Please review the logs in case of errors. -- **Engage with Feedback:** Respond promptly to reviewer comments and make necessary updates. -- **Be Patient:** Reviewers may take time to go through your PR. -- **Ask for Help Anytime:** Contributing to an open-source project might be challenging. Please share any concerns or ask for clarifications when needed. We are here to help you. - -By following these steps, you'll create a high-quality PR that is easier to review and more likely to be accepted. Thank you for contributing! - -### Additional Support - -This project provides automatic comments in PRs when certain conditions are met. These comments include checklists to guide contributors through the required steps. Here are some examples: - -**When a compliance check is added/modified** - -The bot provides this checklist to ensure the updated compliance checks meet all project requirements. - -![Checklist for compliance check updates with questions to validate changes, including schema generation, migrations, tests, and severity validation](https://github.com/user-attachments/assets/fb7fddbf-1592-4213-bf4d-821a7f8c8be8) - -**When a migration is added/modified** - -This checklist ensures that contributors validate schema generation and rollback behavior while avoiding edits to existing migrations. - -![Checklist for migration updates with reminders about schema generation and rollback testing, and a note to avoid editing existing migrations](https://github.com/user-attachments/assets/169bea0d-b2aa-4c7e-84e2-9fb4f52ac289) - - -## Current Initiatives - -Here you can find the best ways to make meaningful contributions to the project. - -### Solve Technical Debt - -You can always take the lead and contribute to the project by solving [technical debt issues](https://github.com/OpenPathfinder/visionBoard/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen+label%3Atechnical-debt). Most of these issues don’t require a heavy investment, especially the ones tagged as [good first issue](https://github.com/OpenPathfinder/visionBoard/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). - -### Research on Compliance Checks - -You can help us by researching how the checks should work. A key part of this process is defining a way to implement the compliance checks (e.g., data usage, alerting criteria, etc.). Use the combo tags [compliance-checks + research-needed](https://github.com/OpenPathfinder/visionBoard/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen+label%3Acompliance-checks+label%3Aresearch-needed) to identify these opportunities. - -### Add Compliance Checks - -We are looking for contributors to implement compliance checks in the Dashboard. Here’s how you can get started: - -1. Check the open issues related to [compliance-checks + implementation-needed](https://github.com/OpenPathfinder/visionBoard/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen+label%3Acompliance-checks+label%3Aimplementation-needed). - -2. Engage in the conversation and request to lead or contribute to the implementation. A key part of this process is ensuring that the definitions are clear before starting development. - -3. Start development by completing the following tasks: - -#### Development Steps - -- **1. Define a Good Implementation ([Example](https://github.com/OpenPathfinder/visionBoard/issues/43#issuecomment-2524594504)):** - - Read the documentation (guidelines, best practices, etc.). - - Brainstorm the implementation details (logic, alerts, tasks, validations, edge cases, etc.). - - Reach an agreement on the implementation details before starting. - -- **2. Update Check Record ([Example](https://github.com/OpenPathfinder/visionBoard/commit/55eaac59920a5229ef9eeaf859943578a66d1aeb)):** - - Update the `compliance_checks` row with fields like `how_to_url`, `implementation_status`, `implementation_type`, and `implementation_details_reference`. - - Test migration scripts using `npm run db:migrate` and `npm run db:rollback`. - - Update the database schema with `npm run db:generate-schema`. - -- **3. Implement the Business Logic ([Validator Example](https://github.com/OpenPathfinder/visionBoard/commit/44c41d119f0daefb7b2e496ba35d5ab65bcc319b) and [Check Example](https://github.com/OpenPathfinder/visionBoard/commit/6f1e16129ee0d01a1b9b536cd2dc6090b048b71f)):** - - Add the specific validator in `src/checks/validators/index.js`. - - Add the check logic in `src/checks/complianceChecks`. - - Calculate `severity` accurately (`getSeverityFromPriorityGroup`). - - Update relevant database tables (`compliance_checks_alerts`, `compliance_checks_tasks`, `compliance_checks_results`). - -- **4. Ensure It Works as Expected:** - - Add unit tests for the validator check. - - Add integration test cases for the check. - - Verify all tests pass. - - Run `check run --name {check_code_name}` and verify database changes. Update the seed script if necessary (`npm run db:seed`). - -- **5. Update the Website ([Example](https://github.com/OpenPathfinder/website/pull/9)):** - - Review content at `https://openjs-security-program-standards.netlify.app/details/{check_code_name}`. - - Create a PR to include check calculation details and mitigation information. - -### Other - -Any issue labeled [help wanted](https://github.com/OpenPathfinder/visionBoard/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) or [good first issue](https://github.com/OpenPathfinder/visionBoard/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) is a great opportunity to help the project. - -## Developer's Certificate of Origin 1.1 - - -```text -By making a contribution to this project, I certify that: - - (a) The contribution was created in whole or in part by me and I - have the right to submit it under the open source license - indicated in the file; or - - (b) The contribution is based upon previous work that, to the best - of my knowledge, is covered under an appropriate open source - license and I have the right under that license to submit that - work with modifications, whether created in whole or in part - by me, under the same open source license (unless I am - permitted to submit under a different license), as indicated - in the file; or - - (c) The contribution was provided directly to me by some other - person who certified (a), (b) or (c) and I have not modified - it. - - (d) I understand and agree that this project and the contribution - are public and that a record of the contribution (including all - personal information I submit with it, including my sign-off) is - maintained indefinitely and may be redistributed consistent with - this project or the open source license(s) involved. -``` +See the [Contribution Guide](https://openpathfinder.com/contribute) in the website for more information. \ No newline at end of file diff --git a/README.md b/README.md index e46bbc4..fa86e1e 100644 --- a/README.md +++ b/README.md @@ -10,272 +10,29 @@ This project aims to provide a secure and user-friendly dashboard for managing a ## Table of Contents -1. [Motivation](#motivation) - - [More context](#more-context) - - [Engage now](#engage-now) -2. [Getting Started](#getting-started) - - [Prerequisites](#prerequisites) - - [Infrastructure Setup](#infrastructure-setup) - - [Configuration](#configuration) -3. [Usage](#usage) - - [Projects](#projects) - - [Workflows](#workflows) - - [Checks](#checks) -4. [Report Management](#report-management) -5. [Database Management](#database-management) - - [Migrations](#migrations) - - [Seeding](#seeding) - - [Schema Management](#schema-management) -6. [Development](#development) - - [Debugging](#debugging) - - [Linting](#linting) - - [Testing](#testing) -7. [Community Guidelines](#community-guidelines) -8. [License](#license) - ---- - -## Motivation - -The goal of this project is to streamline the secure management of OpenJS Foundation projects by providing an intuitive dashboard with robust infrastructure support. It emphasizes security, simplicity, and extensibility ✨ - -### More Context - -A few months ago, we started a discussion about [the OpenJS Security Collab space initiative](https://github.com/openjs-foundation/security-collab-space) ("[Security Program Standards](https://github.com/openjs-foundation/security-collab-space/issues/211)") to build a dashboard for monitoring security parameters in our projects (Node.js, Electron, jQuery, Express, etc.). After carefully planning and securing resources, we are now at an exciting point as we’ve recently launched a pilot program with some projects. 🚀 - -So far, we’ve developed this website: [https://openjs-security-program-standards.netlify.app/](https://openjs-security-program-standards.netlify.app/), which is based on the checklist ([Google Sheet](https://docs.google.com/spreadsheets/d/1GwIsAudAn89xv9DAbr1HUaY4KEVBsYfg--_1cW0uIB0/edit#gid=0)) and the introductory document ([Google Doc](https://docs.google.com/document/d/1tvJYtptFXqvS4863dhPwoVmFT5Jwr_WZLralrnulCZs/edit)) that we compiled during our original research. 😄 - -You can watch this [YouTube video](https://www.youtube.com/watch?v=B1kd8k5SvBI) for a proper introduction to the Dashboard and website (both Proof of Concept versions) built based on feedback from [the Express Security WG](https://github.com/expressjs/security-wg) and others. - -In essence, this tool collects information from multiple sources, evaluates it, transforms it into actionable insights, and uses it to build dashboards, tasks, and alerts at both the foundation and project levels. If you prefer a non-video format, here are [the slides](https://slides.ulisesgascon.com/openjs-security-program-standards/) and [the code repository](https://github.com/UlisesGascon/poc-openjs-security-program-standards-dashboard/blob/main/README.md). - -Currently, we are focused on building a solid MVP and onboarding new contributors, aiming to create a great product by the end of this process. 😎 - -### Engage Now - -Yes, we are looking for HELP in many ways! 😇 Let’s collaborate and have fun together. You can find more information in [the contributing guide](CONTRIBUTING.md). 🌟 - -Another great way to get involved is by participating in [the OpenJS Security Collab Space](https://github.com/openjs-foundation/security-collab-space). We hold regular meetings to discuss this initiative and many other exciting topics. - -The project includes a [technical architecture guide](/ARCHITECTURE.md) that provides in-depth explanations of various concepts. - ---- - -## Getting Started - -### Prerequisites - -- Node.js 22 and npm -- Docker and Docker Compose -- GitHub token with `repo:read` access level (not needed for development) - -### Infrastructure Setup - -This project requires a PostgreSQL database and includes an instance of [Adminer](https://www.adminer.org/) accessible at `http://localhost:8080`. - -#### Start Infrastructure - -```bash -npm run infra:start -``` - -#### Stop Infrastructure - -```bash -npm run infra:stop -``` - -### Configuration - - -#### Environment Variables - -Set the `GITHUB_TOKEN` environment variable to authenticate with the GitHub API. - -Optionally, use a `.env` file: -``` -GITHUB_TOKEN=your_github_token_here -``` - -Then load it using: - -```bash -node --env-file=.env visionboard.js workflow run --name populate-repos-list -``` - -## Usage - -### Projects - -Add a new project: - -```bash -node visionboard.js project add [--name ] [--github-urls ] -``` - -Example: - -```bash -node visionboard.js project add --name express --github-urls https://github.com/expressjs https://github.com/pillarjs https://github.com/jshttp -``` - -### Workflows - -Run a workflow: - -```bash -node visionboard.js workflow run [--name ] -``` - -List workflows: - -```bash -node visionboard.js workflow list -``` - -### Checks - -List all checks: - -```bash -node visionboard.js check list -``` -Run a specific check: - -```bash -node visionboard.js check run [--name ] -``` - -There is an specific workflow that runs all the checks sequentially: - -```bash -node visionboard.js workflow run run-all-checks -``` - -### Checklist - -The checklist are collections of checks. You can list the available list by running: - -```bash -node visionboard.js checklist list -``` - -Run a specific checklist: - -```bash -node visionboard.js checklist run [--name ] -``` - - -It is possible also to define a project scope: - -```bash -node visionboard.js checklist run [--name ] [--project-scope ] -``` - -## Report Management - -visionBoard has the capability of generating reports that can be used to analyze data. - -### Generate the Reports - -_Not yet implemented_ - -### Showcase the Reports - -The simplest option is to run the workflow `show-reports`, which will start an HTTP server that lists the content in the `output` folder. Any asset previously generated can be accessed via a web browser using this approach. You can start the server by running: - -```bash -node visionboard.js workflow run --name show-reports -``` - -You can customize the IP and port using the environment variables `PORT` and `IP`. By default, it uses `localhost:3000`. - - -## Database Management - -### Migrations - -Run latest migrations: - -```bash -npm run db:migrate -``` - -Rollback migrations: - -```bash -npm run db:rollback -``` - -### Seeding - -Seed the database: - -```bash -npm run db:seed -``` - -### Schema Management - -Check the schema: - -Refer to the latest schema file at [/src/database/schema/schema.sql](src/database/schema/schema.sql). - -Update the schema: - -```bash -npm run db:generate-schema -``` - -## Development - -### Debugging - -Enable debug logs using the `DEBUG` environment variable: - -```bash -DEBUG=* node visionboard.js -``` - -### Linting - -Run lint checks: - -```bash -npm run lint -``` - -Fix lint issues: - -```bash -npm run lint:fix -``` - -### Testing - -Run tests: - -```bash -npm test -``` - -Run tests with coverage: - -```bash -npm run test:coverage -``` - -Update the snapshots when needed: -```bash -npm run test -- -u -``` - -## Community Guidelines - -We encourage contributors to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) and [Contributing Guidelines](CONTRIBUTING.md). Security-related concerns should follow our [Security Policy](SECURITY.md). - - -## License - -This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. \ No newline at end of file +1. [Context](https://openpathfinder.com/docs/getting-started) + - [Key Feature](https://openpathfinder.com/docs/visionBoard#key-features) + - [Demo Walkthrough](https://openpathfinder.com/docs/visionBoard#demo-walkthrough) + - [Why visionBoard?](https://openpathfinder.com/docs/visionBoard#why-visionboard) + - [History](https://openpathfinder.com/docs/history) +2. [Installation](https://openpathfinder.com/docs/visionBoard/installation) + - [npm](https://openpathfinder.com/docs/visionBoard/installation#install-via-npm) + - [docker](https://openpathfinder.com/docs/visionBoard/installation#using-docker) + - [source code](https://openpathfinder.com/docs/visionBoard/installation#from-source-code) +3. [Configuration](https://openpathfinder.com/docs/visionBoard/configuration) + - [Secrets Management](https://openpathfinder.com/docs/visionBoard/configuration#secrets-management) +4. [Usage](https://openpathfinder.com/docs/visionBoard/usage) + - [CLI Commands](https://openpathfinder.com/docs/visionBoard/usage#cli-commands) +5. [Architecture](https://openpathfinder.com/docs/visionBoard/architecture) + - [Context](https://openpathfinder.com/docs/visionBoard/architecture#context) + - [Entities](https://openpathfinder.com/docs/visionBoard/architecture#entities) + - [Internal parts](https://openpathfinder.com/docs/visionBoard/architecture#internal-parts) +6. [Report Management](https://openpathfinder.com/docs/visionBoard/report-management) + - [Generate Reports](https://openpathfinder.com/docs/visionBoard/report-management#generate-the-reports) + - [Showcase the Reports](https://openpathfinder.com/docs/visionBoard/report-management#showcase-the-reports) +7. [Database Management](https://openpathfinder.com/docs/visionBoard/database-management) + - [Schema Management](https://openpathfinder.com/docs/visionBoard/database-management#schema-management) + - [Migrations](https://openpathfinder.com/docs/visionBoard/database-management#migrations) + - [Seeding](https://openpathfinder.com/docs/visionBoard/database-management#migrations) +8. [Compliance Checks](https://openpathfinder.com/docs/visionBoard/Checks) +9. [Compliance Checklists](https://openpathfinder.com/docs/visionBoard/checklists)