docs: Prepare for website deployment #42
Conversation
| * [Configuration](./docs/configuration.md) - Learn how to configure the server | ||
| * [API Reference](./docs/api-reference.md) - Learn about the OCP REST API | ||
| * [Authentication](./docs/authentication.md) - Learn how to secure the server API | ||
| - [Deploy as a service](http://openpolicyagent.org/docs/ocp/guide-deploy-as-a-service) - Run OCP as a standalone service in Kubernetes |
There was a problem hiding this comment.
I wonder, instead of maintaining documentation in the main OPA repo, would it be possible to keep the docs here, and link in the md:s in OPA when building the docs? Or would that just be more work in the end?
Another alternative could be to have a separate docs repo for the website that links it all together, since they're describing multiple projects anyways.
I'm sure we've already considered alternatives to the current strategy, though, and this is the appropriate solution 🙂.
There was a problem hiding this comment.
I wonder, instead of maintaining documentation in the main OPA repo, would it be possible to keep the docs here
We can do this if we'd like to in future. This is what we have for regal, and will have for some other projects too (style guide, cheat sheet etc.) however, for now, this was easiest to get them in the right place.
There was a preference for the OCP docs to be in the side nav on the OPA site and so for now it made sense to have those files versioned alongside other pages which appear in the main docs.
There will need to be more changes in future, but this is all that's needed for an initial pass. Signed-off-by: Charlie Egan <[email protected]>
Docs are to be maintained in the main OPA repo. Signed-off-by: Charlie Egan <[email protected]>
Signed-off-by: Charlie Egan <[email protected]>
charlieegan3
force-pushed
the
opa-docs-prep
branch
from
f5fb44b to
2d7cb6a
Compare
|
Thanks for the review Johan, I have the minor edit to auth.md in open-policy-agent/opa#7904. Will merge this now to avoid future confusion. |
Replaces #41
open-policy-agent/opa#7875 will bring these docs into the main OPA repo to be managed there going forward.
There will be some future readme updates too, but for now I've mostly left in place, but we don't really want to have this content duplicated in the long run.