Generate static website for documentation #883
Conversation
Signed-off-by: Sertac Ozercan <sozercan@gmail.com>
Codecov Report
@@ Coverage Diff @@
## master #883 +/- ##
==========================================
+ Coverage 43.56% 43.72% +0.15%
==========================================
Files 47 47
Lines 3170 3170
==========================================
+ Hits 1381 1386 +5
+ Misses 1594 1591 -3
+ Partials 195 193 -2
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
Signed-off-by: Sertac Ozercan <sozercan@gmail.com>
| title: How to use Gatekeeper | ||
| --- | ||
|
|
||
| Gatekeeper uses the [OPA Constraint Framework](https://github.com/open-policy-agent/frameworks/tree/master/constraint) to describe and enforce policy. Look there for more detailed information on their semantics and advanced usage. |
There was a problem hiding this comment.
This may be fine just to get the PR out, but I think we should clean up the documentation split a bit.
The constraint framework should definitely have the most detailed info on how things work, but much of it will likely only be relevant for people interested in writing targets or enforcement points.
Maybe this means we create a section of the CF documentation explicitly on using constraints/templates? Maybe we add documentation on how to write templates to the library?
I'm not sure what the best solution is. Whatever we do, we should make sure user's aren't overwhelmed and we should avoid repeating ourselves (which the linking does nicely).
There was a problem hiding this comment.
we create a section of the CF documentation explicitly on using constraints/templates?
The constraint framework should definitely have the most detailed info on how things work, but much of it will likely only be relevant for people interested in writing targets or enforcement points.
I think we should add this doc in the CF repo.
website/docusaurus.config.js
Outdated
| baseUrl: '/gatekeeper/website/', | ||
| onBrokenLinks: 'throw', | ||
| favicon: 'img/favicon.ico', | ||
| organizationName: 'sozercan', // TODO(sertac): update to openpolicyagent before merging |
There was a problem hiding this comment.
This is known. Will need to update before merge, otherwise preview in my fork will be broken
Signed-off-by: Sertac Ozercan <sozercan@gmail.com>
Signed-off-by: Sertac Ozercan <sozercan@gmail.com>
Signed-off-by: Sertac Ozercan <sozercan@gmail.com>
Signed-off-by: Sertac Ozercan sozercan@gmail.com
What this PR does / why we need it:
Gatekeeper readme has grown substantially and needs better organization and versioning over time. We can use a statically hosted page in github pages to host our docs in a user-friendly way. Readme can be trimmed down to just basics and can point to docs website for more information.
This flow uses
websitefolder to generate a static website using docusaurus. When a new commit is merged towebsitefolder, it'll generategenerate_websiteGithub action to start deployment process, which will push the static pages togh-pagesbranch. Since we also upload our charts ingh-pagesbranch, it'll be hosted inwebsitefolder there.Pages are written with markdown (under
website/docs). I moved over the existing readme into markdown files inwebsite/docsand divided into categories for easier organization.Current version is hosted here: https://sozercan.github.io/gatekeeper/
It'll be hosted in https://open-policy-agent.github.io/gatekeeper/ when it's merged (will 404 now).
Which issue(s) this PR fixes (optional, using
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when the PR gets merged):Fixes #838
Special notes for your reviewer: