mirror of
https://github.com/open-policy-agent/opa.git
synced 2026-08-28 11:15:32 -06:00
Torin Sandall
7c20f40844
Also, update Jekyll configuration to use Redcarpet as Kramdown was inserting extra spaces into code blocks. This was making the EOF line not get recognized in the heredocs. Also, fix missing commas in one of the arch.md policy snippets.
47 lines
1.2 KiB
Markdown
47 lines
1.2 KiB
Markdown
# Site Updates
|
|
|
|
We use GitHub pages to host the website that includes all of the OPA documentation. In order
|
|
to update the website, you need to have write permission on the open-policy-agent/opa repository.
|
|
|
|
You also need to have [Jekyll](http://jekyllrb.com) installed to build the site. If you are
|
|
not sure how to install Jekyll, see the link for details. Assuming you have Ruby installed,
|
|
all you should need to do is run:
|
|
|
|
```
|
|
gem install --user-install jekyll
|
|
gem install --user-install redcarpet
|
|
```
|
|
|
|
To update the website perform the following steps:
|
|
|
|
1. Obtain a fresh copy of the repository
|
|
|
|
```
|
|
git clone git@github.com:open-policy-agent/opa.git opa-site
|
|
```
|
|
|
|
- Note: if you are preparing documentation for a specific release, checkout the release
|
|
tag in this step as well.
|
|
|
|
1. Build the site content and save the output:
|
|
|
|
```
|
|
cd opa-site/docs
|
|
jekyll build .
|
|
tar czvf ~/site.tar.gz -C _site .
|
|
```
|
|
|
|
1. Checkout the gh-pages branch and overlay the new site content:
|
|
|
|
```
|
|
git checkout gh-pages
|
|
tar zxvf ~/site.tar.gz
|
|
git commit -a -m "Updating site for release 0.12.8"
|
|
```
|
|
|
|
1. Push the gh-pages branch back to GitHub:
|
|
|
|
```
|
|
git push origin gh-pages
|
|
```
|