Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
Signed-off-by: Charlie Egan <charlie@styra.com>
  • Loading branch information
charlieegan3 committed Aug 30, 2023
1 parent 8459725 commit e473f62
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 2,904 deletions.
20 changes: 11 additions & 9 deletions docs/README.md
Expand Up @@ -50,8 +50,13 @@ complexities to be aware of when making changes to the site's layout:
(edge, latest and all versions) when merged to `main`.
* Site [data](./website/data) treated in the same way, so updates to data files also
apply to all versions as soon as they are merged.
* Site [content/](./content/), when merged to `main`, is only shown on `edge` until the
* Docs [content/](./content/), when merged to `main`, is only shown on `edge` until the
next release.
* Other, unversioned [content/](./website/content/) is shown immediately after merging.
This includes pages in the [OPA Ecosystem](https://www.openpolicyagent.org/ecosystem/)
as well as [Security](https://www.openpolicyagent.org/security/),
[Support](https://www.openpolicyagent.org/support/), and
[Community](https://www.openpolicyagent.org/community/) pages.

## How to Edit and Test

Expand Down Expand Up @@ -299,7 +304,7 @@ another group's module when evaluating (e.g. so that they can be imported).
# OPA Ecosystem

The [OPA Ecosystem](https://www.openpolicyagent.org/docs/latest/ecosystem/)
The [OPA Ecosystem](https://www.openpolicyagent.org/ecosystem/)
makes it easy to find either a specific integration with OPA
or to browse the integrations with OPA within a particular category. It pulls
information about different integrations (e.g. blogs, videos, tutorials, code) into a
Expand All @@ -309,15 +314,14 @@ single place while allowing integration authors to update the docs content as ne

Source information for the OPA Ecosystem is stored in the following places:

- [content/integrations/](./content/integrations) - each file creates a page in the OPA Ecosystem for a particular integration.
- [content/organizations/](./content/organizations) - each file is a page for organizations and companies associated with integrations.
- [content/softwares/](./content/softwares) - each file is for software categories related to integrations.
- [content/integrations/](./website/content/integrations) - each file creates a page in the OPA Ecosystem for a particular integration.
- [content/organizations/](./website/content/organizations) - each file is a page for organizations and companies associated with integrations.
- [content/softwares/](./website/content/softwares) - each file is for software categories related to integrations.

Integrations should have a file in `content/integrations/` with the following schema:
Integrations should have a file in `/docs/website/content/integrations/` with the following schema:

```md
---
layout: integration-single # required to be set and to this value
title: <integration name>
software:
- <related software>
Expand Down Expand Up @@ -349,7 +353,6 @@ Organizations have the following format:
---
link: https://example.com
title: <organization name>
layout: organization-single # required to be set and to this value
---
```

Expand All @@ -360,7 +363,6 @@ Software categories have the following format:
---
link: https://example.com
title: <software name>
layout: software-single # required to be set and to this value
---
```

Expand Down
2 changes: 1 addition & 1 deletion docs/content/contributing.md
Expand Up @@ -27,7 +27,7 @@ We welcome contributions of all kinds. For example:
- [Documentation](../contrib-docs) including reference material and examples.
- Help out other members in the OPA Slack Org and on the [GitHub Discussions Board](https://github.com/open-policy-agent/feedback/discussions)
- Spreading the word about OPA by speaking at conferences
- Adding integrations to the OPA [ecosystem](https://www.openpolicyagent.org/docs/latest/ecosystem/)
- Adding integrations to the OPA [ecosystem](https://www.openpolicyagent.org/ecosystem/)
- Creating Blog and Videos to show how your organization has implemented OPA

If you're interested in any non-code contributions, please reach out on the #help channel on [Slack](https://slack.openpolicyagent.org/)

0 comments on commit e473f62

Please sign in to comment.