mirror of
https://github.com/open-policy-agent/opa.git
synced 2026-08-27 02:34:52 -06:00
d6b5659856
Some things added on this branch: - icons and client logos at known paths - some spam redirects - some redirects for docs/latest/foo /docs/foo - redirects for the two ‘moved’ pages (k8s and envoy intros) I am going to be monitoring the traffic this week on Netlify to make sure we have a good coverage with redirects where needed. We also now prompt users to file issues directly from the 404 pages which should help flag things we miss too.
33 lines
638 B
Markdown
33 lines
638 B
Markdown
# Documentation and Website Development
|
|
|
|
This README contains an overview of the development environment for the
|
|
OPA website.
|
|
|
|
## Development
|
|
|
|
Those contributing to the OPA website must first install the Node packages to
|
|
run it:
|
|
|
|
```bash
|
|
make install
|
|
```
|
|
|
|
Once these have been installed, a live updating development server can be
|
|
started by running
|
|
|
|
```bash
|
|
make dev
|
|
```
|
|
|
|
Note, that the server will not restart when you change the
|
|
`docusaurus.config.js`.
|
|
|
|
You can run a local build of the website by running:
|
|
|
|
```bash
|
|
make build
|
|
```
|
|
|
|
This will build a version of the site ready for deployment. Broken links are
|
|
also checked in this step.
|