From 58d336aff95d2da9be7bc8aad6113d2270bd203a Mon Sep 17 00:00:00 2001 From: Patrick East Date: Thu, 25 Apr 2019 21:37:56 -0700 Subject: [PATCH] Refactor doc directories Signed-off-by: Patrick East --- docs/Makefile | 19 +++++++++----- docs/README.md | 24 +++++++++++------- docs/{ => website}/.editorconfig | 0 docs/{ => website}/.gitignore | 0 docs/{ => website}/RELEASES | 0 docs/{ => website}/assets/js/app.js | 0 docs/{ => website}/assets/sass/custom.sass | 0 docs/{ => website}/assets/sass/docs.sass | 0 docs/{ => website}/assets/sass/style.sass | 0 docs/{ => website}/assets/sass/toc.sass | 0 docs/{ => website}/config.toml | 0 docs/{ => website}/data/redirects.yaml | 0 docs/{ => website}/data/traits.yaml | 0 .../layouts/_default/baseof.html | 0 .../layouts/docs/section.en.html | 0 .../{ => website}/layouts/docs/single.en.html | 0 docs/{ => website}/layouts/index.html | 0 docs/{ => website}/layouts/index.redirects | 0 docs/{ => website}/layouts/partials/css.html | 0 .../layouts/partials/docs/article.html | 0 .../layouts/partials/docs/dashboard.html | 0 .../layouts/partials/docs/hero.html | 0 .../layouts/partials/docs/navbar.html | 0 .../layouts/partials/docs/sidenav.html | 0 .../partials/docs/sidenav/production.html | 0 .../layouts/partials/google-analytics.html | 0 .../layouts/partials/home/banner.html | 0 .../layouts/partials/home/footer.html | 0 .../layouts/partials/home/svg.html | 0 .../layouts/partials/home/traits.html | 0 .../layouts/partials/home/use-cases.html | 0 .../layouts/partials/javascript.html | 0 docs/{ => website}/layouts/partials/meta.html | 0 .../layouts/shortcodes/code.html | 0 .../layouts/shortcodes/figure.html | 0 .../layouts/shortcodes/latest.html | 0 .../node_modules/bulma/CHANGELOG.md | 0 docs/{ => website}/node_modules/bulma/LICENSE | 0 .../node_modules/bulma/README.md | 0 .../node_modules/bulma/bulma.sass | 0 .../node_modules/bulma/css/bulma.css | 0 .../node_modules/bulma/css/bulma.css.map | 0 .../node_modules/bulma/css/bulma.min.css | 0 .../node_modules/bulma/package.json | 0 .../node_modules/bulma/sass/base/_all.sass | 0 .../node_modules/bulma/sass/base/generic.sass | 0 .../node_modules/bulma/sass/base/helpers.sass | 0 .../bulma/sass/base/minireset.sass | 0 .../bulma/sass/components/_all.sass | 0 .../bulma/sass/components/breadcrumb.sass | 0 .../bulma/sass/components/card.sass | 0 .../bulma/sass/components/dropdown.sass | 0 .../bulma/sass/components/level.sass | 0 .../bulma/sass/components/list.sass | 0 .../bulma/sass/components/media.sass | 0 .../bulma/sass/components/menu.sass | 0 .../bulma/sass/components/message.sass | 0 .../bulma/sass/components/modal.sass | 0 .../bulma/sass/components/navbar.sass | 0 .../bulma/sass/components/pagination.sass | 0 .../bulma/sass/components/panel.sass | 0 .../bulma/sass/components/tabs.sass | 0 .../bulma/sass/elements/_all.sass | 0 .../node_modules/bulma/sass/elements/box.sass | 0 .../bulma/sass/elements/button.sass | 0 .../bulma/sass/elements/container.sass | 0 .../bulma/sass/elements/content.sass | 0 .../bulma/sass/elements/form.sass | 0 .../bulma/sass/elements/icon.sass | 0 .../bulma/sass/elements/image.sass | 0 .../bulma/sass/elements/notification.sass | 0 .../bulma/sass/elements/other.sass | 0 .../bulma/sass/elements/progress.sass | 0 .../bulma/sass/elements/table.sass | 0 .../node_modules/bulma/sass/elements/tag.sass | 0 .../bulma/sass/elements/title.sass | 0 .../node_modules/bulma/sass/grid/_all.sass | 0 .../node_modules/bulma/sass/grid/columns.sass | 0 .../node_modules/bulma/sass/grid/tiles.sass | 0 .../node_modules/bulma/sass/layout/_all.sass | 0 .../bulma/sass/layout/footer.sass | 0 .../node_modules/bulma/sass/layout/hero.sass | 0 .../bulma/sass/layout/section.sass | 0 .../bulma/sass/utilities/_all.sass | 0 .../bulma/sass/utilities/animations.sass | 0 .../bulma/sass/utilities/controls.sass | 0 .../sass/utilities/derived-variables.sass | 0 .../bulma/sass/utilities/functions.sass | 0 .../sass/utilities/initial-variables.sass | 0 .../bulma/sass/utilities/mixins.sass | 0 docs/{ => website}/package-lock.json | 0 docs/{ => website}/package.json | 0 docs/{ => website}/scripts/load-docs.sh | 13 +++++----- docs/{ => website}/static/css/home.css | 0 docs/{ => website}/static/favicon.png | Bin docs/{ => website}/static/img/Github.svg | 0 docs/{ => website}/static/img/Medium.svg | 0 docs/{ => website}/static/img/Slack.svg | 0 .../static/img/api-authorization.svg | 0 docs/{ => website}/static/img/boat.svg | 0 docs/{ => website}/static/img/cloud.svg | 0 .../{ => website}/static/img/context-icon.svg | 0 .../static/img/declarative-icon.svg | 0 .../img/kubernetes-admission-control.svg | 0 .../static/img/logos/opa-horizontal-color.png | Bin .../static/img/logos/opa-icon-white.png | Bin .../static/img/logos/opa-stacked-color.png | Bin docs/{ => website}/static/img/opa-logo.svg | 0 .../static/img/partial-evaluation.svg | 0 docs/{ => website}/static/img/sea-plants.svg | 0 .../static/img/ssh-authorization.svg | 0 .../{ => website}/static/img/unified-icon.svg | 0 .../static/img/viking-village.svg | 0 .../static/img/wave--examples.svg | 0 .../static/img/wave--headline--bg.svg | 0 .../static/img/wave--headline--fg.svg | 0 .../static/img/wave--use-cases.svg | 0 docs/{ => website}/static/js/home.js | 0 netlify.toml | 4 +-- 119 files changed, 36 insertions(+), 24 deletions(-) rename docs/{ => website}/.editorconfig (100%) rename docs/{ => website}/.gitignore (100%) rename docs/{ => website}/RELEASES (100%) rename docs/{ => website}/assets/js/app.js (100%) rename docs/{ => website}/assets/sass/custom.sass (100%) rename docs/{ => website}/assets/sass/docs.sass (100%) rename docs/{ => website}/assets/sass/style.sass (100%) rename docs/{ => website}/assets/sass/toc.sass (100%) rename docs/{ => website}/config.toml (100%) rename docs/{ => website}/data/redirects.yaml (100%) rename docs/{ => website}/data/traits.yaml (100%) rename docs/{ => website}/layouts/_default/baseof.html (100%) rename docs/{ => website}/layouts/docs/section.en.html (100%) rename docs/{ => website}/layouts/docs/single.en.html (100%) rename docs/{ => website}/layouts/index.html (100%) rename docs/{ => website}/layouts/index.redirects (100%) rename docs/{ => website}/layouts/partials/css.html (100%) rename docs/{ => website}/layouts/partials/docs/article.html (100%) rename docs/{ => website}/layouts/partials/docs/dashboard.html (100%) rename docs/{ => website}/layouts/partials/docs/hero.html (100%) rename docs/{ => website}/layouts/partials/docs/navbar.html (100%) rename docs/{ => website}/layouts/partials/docs/sidenav.html (100%) rename docs/{ => website}/layouts/partials/docs/sidenav/production.html (100%) rename docs/{ => website}/layouts/partials/google-analytics.html (100%) rename docs/{ => website}/layouts/partials/home/banner.html (100%) rename docs/{ => website}/layouts/partials/home/footer.html (100%) rename docs/{ => website}/layouts/partials/home/svg.html (100%) rename docs/{ => website}/layouts/partials/home/traits.html (100%) rename docs/{ => website}/layouts/partials/home/use-cases.html (100%) rename docs/{ => website}/layouts/partials/javascript.html (100%) rename docs/{ => website}/layouts/partials/meta.html (100%) rename docs/{ => website}/layouts/shortcodes/code.html (100%) rename docs/{ => website}/layouts/shortcodes/figure.html (100%) rename docs/{ => website}/layouts/shortcodes/latest.html (100%) rename docs/{ => website}/node_modules/bulma/CHANGELOG.md (100%) rename docs/{ => website}/node_modules/bulma/LICENSE (100%) rename docs/{ => website}/node_modules/bulma/README.md (100%) rename docs/{ => website}/node_modules/bulma/bulma.sass (100%) rename docs/{ => website}/node_modules/bulma/css/bulma.css (100%) rename docs/{ => website}/node_modules/bulma/css/bulma.css.map (100%) rename docs/{ => website}/node_modules/bulma/css/bulma.min.css (100%) rename docs/{ => website}/node_modules/bulma/package.json (100%) rename docs/{ => website}/node_modules/bulma/sass/base/_all.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/base/generic.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/base/helpers.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/base/minireset.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/components/_all.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/components/breadcrumb.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/components/card.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/components/dropdown.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/components/level.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/components/list.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/components/media.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/components/menu.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/components/message.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/components/modal.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/components/navbar.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/components/pagination.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/components/panel.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/components/tabs.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/elements/_all.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/elements/box.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/elements/button.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/elements/container.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/elements/content.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/elements/form.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/elements/icon.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/elements/image.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/elements/notification.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/elements/other.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/elements/progress.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/elements/table.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/elements/tag.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/elements/title.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/grid/_all.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/grid/columns.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/grid/tiles.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/layout/_all.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/layout/footer.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/layout/hero.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/layout/section.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/utilities/_all.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/utilities/animations.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/utilities/controls.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/utilities/derived-variables.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/utilities/functions.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/utilities/initial-variables.sass (100%) rename docs/{ => website}/node_modules/bulma/sass/utilities/mixins.sass (100%) rename docs/{ => website}/package-lock.json (100%) rename docs/{ => website}/package.json (100%) rename docs/{ => website}/scripts/load-docs.sh (89%) rename docs/{ => website}/static/css/home.css (100%) rename docs/{ => website}/static/favicon.png (100%) rename docs/{ => website}/static/img/Github.svg (100%) rename docs/{ => website}/static/img/Medium.svg (100%) rename docs/{ => website}/static/img/Slack.svg (100%) rename docs/{ => website}/static/img/api-authorization.svg (100%) rename docs/{ => website}/static/img/boat.svg (100%) rename docs/{ => website}/static/img/cloud.svg (100%) rename docs/{ => website}/static/img/context-icon.svg (100%) rename docs/{ => website}/static/img/declarative-icon.svg (100%) rename docs/{ => website}/static/img/kubernetes-admission-control.svg (100%) rename docs/{ => website}/static/img/logos/opa-horizontal-color.png (100%) rename docs/{ => website}/static/img/logos/opa-icon-white.png (100%) rename docs/{ => website}/static/img/logos/opa-stacked-color.png (100%) rename docs/{ => website}/static/img/opa-logo.svg (100%) rename docs/{ => website}/static/img/partial-evaluation.svg (100%) rename docs/{ => website}/static/img/sea-plants.svg (100%) rename docs/{ => website}/static/img/ssh-authorization.svg (100%) rename docs/{ => website}/static/img/unified-icon.svg (100%) rename docs/{ => website}/static/img/viking-village.svg (100%) rename docs/{ => website}/static/img/wave--examples.svg (100%) rename docs/{ => website}/static/img/wave--headline--bg.svg (100%) rename docs/{ => website}/static/img/wave--headline--fg.svg (100%) rename docs/{ => website}/static/img/wave--use-cases.svg (100%) rename docs/{ => website}/static/js/home.js (100%) diff --git a/docs/Makefile b/docs/Makefile index 85ee677c71..209c3c2e70 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,12 +1,12 @@ .PHONY: clean clean: - rm -rf generated - rm -rf public - rm -rf resources + rm -rf $(CURDIR)/website/generated + rm -rf $(CURDIR)/website/public + rm -rf $(CURDIR)/website/esources .PHONY: generate generate: - scripts/load-docs.sh + $(CURDIR)/website/scripts/load-docs.sh .PHONY: setup setup: @@ -16,6 +16,7 @@ setup: hugo-serve: hugo \ server \ + --source $(CURDIR)/website \ --contentDir generated \ --buildDrafts \ --buildFuture @@ -24,19 +25,21 @@ hugo-serve: serve: # must be run from root of repo for # the netlify.toml config to work - cd .. && netlify dev --offline + cd $(CURDIR)/.. && netlify dev --offline .PHONY: docker-serve docker-serve: docker run --rm -it \ - -v $(PWD):/src \ + -v $(CURDIR)/:/src \ -p 1313:1313 \ klakegg/hugo:0.53-ext server \ - --contentDir /src/generated + --source /src/website \ + --contentDir generated .PHONY: production-build production-build: clean generate hugo \ + --source $(CURDIR)/website \ --contentDir generated \ --ignoreCache \ --minify @@ -44,6 +47,7 @@ production-build: clean generate .PHONY: preview-build preview-build: clean generate hugo \ + --source $(CURDIR)/website \ --contentDir generated \ --baseURL $(DEPLOY_PRIME_URL) \ --buildDrafts \ @@ -54,6 +58,7 @@ preview-build: clean generate .PHONY: linkcheck-build linkcheck-build: hugo \ + --source $(CURDIR)/website \ --contentDir generated \ --baseURL "/" \ --buildDrafts \ diff --git a/docs/README.md b/docs/README.md index 40e8bfd445..d85cbe8527 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,15 +1,18 @@ # The OPA Website and Documentation +The content and tooling is separated into a few places: -This directory contains all of the Markdown, HTML, Sass/CSS, and other assets needed -to build the [openpolicyagent.org](https://openpolicyagent.org) website. See the -section below for steps to build the site and test documentation changes -locally. +[devel/](./devel/) - Developer documentation for OPA (not part of the website) -The raw OPA documentation can be found under the [content/docs](./content/docs) -directory. -> ### Developing OPA -> For documentation on developing OPA, see the [devel](./devel) directory. +[website/](./website/) - This directory contains all of the Markdown, HTML, Sass/CSS, +and other assets needed to build the [openpolicyagent.org](https://openpolicyagent.org) +website. See the section below for steps to build the site and test documentation changes +locally. This content is not versioned for each release, it is common scaffolding for +the website. + +[content/](./content/) - The raw OPA documentation can be found under the +directory. This content is versioned for each release and should have all images +and code snippets alongside the markdown content files. ## Run the site locally @@ -27,10 +30,13 @@ To generate them run: ```shell make generate ``` -The content then will be placed into `docs/generated/docs/$VERSION/`. +The content then will be placed into `docs/website/generated/docs/$VERSION/`. ### Run the site locally using Docker +> Note: running with docker only uses the Hugo server and not Netlify locally. +This means that redirects and other Netlify features the site relies on will not work. + If [Docker is running](https://docs.docker.com/get-started/): ```bash diff --git a/docs/.editorconfig b/docs/website/.editorconfig similarity index 100% rename from docs/.editorconfig rename to docs/website/.editorconfig diff --git a/docs/.gitignore b/docs/website/.gitignore similarity index 100% rename from docs/.gitignore rename to docs/website/.gitignore diff --git a/docs/RELEASES b/docs/website/RELEASES similarity index 100% rename from docs/RELEASES rename to docs/website/RELEASES diff --git a/docs/assets/js/app.js b/docs/website/assets/js/app.js similarity index 100% rename from docs/assets/js/app.js rename to docs/website/assets/js/app.js diff --git a/docs/assets/sass/custom.sass b/docs/website/assets/sass/custom.sass similarity index 100% rename from docs/assets/sass/custom.sass rename to docs/website/assets/sass/custom.sass diff --git a/docs/assets/sass/docs.sass b/docs/website/assets/sass/docs.sass similarity index 100% rename from docs/assets/sass/docs.sass rename to docs/website/assets/sass/docs.sass diff --git a/docs/assets/sass/style.sass b/docs/website/assets/sass/style.sass similarity index 100% rename from docs/assets/sass/style.sass rename to docs/website/assets/sass/style.sass diff --git a/docs/assets/sass/toc.sass b/docs/website/assets/sass/toc.sass similarity index 100% rename from docs/assets/sass/toc.sass rename to docs/website/assets/sass/toc.sass diff --git a/docs/config.toml b/docs/website/config.toml similarity index 100% rename from docs/config.toml rename to docs/website/config.toml diff --git a/docs/data/redirects.yaml b/docs/website/data/redirects.yaml similarity index 100% rename from docs/data/redirects.yaml rename to docs/website/data/redirects.yaml diff --git a/docs/data/traits.yaml b/docs/website/data/traits.yaml similarity index 100% rename from docs/data/traits.yaml rename to docs/website/data/traits.yaml diff --git a/docs/layouts/_default/baseof.html b/docs/website/layouts/_default/baseof.html similarity index 100% rename from docs/layouts/_default/baseof.html rename to docs/website/layouts/_default/baseof.html diff --git a/docs/layouts/docs/section.en.html b/docs/website/layouts/docs/section.en.html similarity index 100% rename from docs/layouts/docs/section.en.html rename to docs/website/layouts/docs/section.en.html diff --git a/docs/layouts/docs/single.en.html b/docs/website/layouts/docs/single.en.html similarity index 100% rename from docs/layouts/docs/single.en.html rename to docs/website/layouts/docs/single.en.html diff --git a/docs/layouts/index.html b/docs/website/layouts/index.html similarity index 100% rename from docs/layouts/index.html rename to docs/website/layouts/index.html diff --git a/docs/layouts/index.redirects b/docs/website/layouts/index.redirects similarity index 100% rename from docs/layouts/index.redirects rename to docs/website/layouts/index.redirects diff --git a/docs/layouts/partials/css.html b/docs/website/layouts/partials/css.html similarity index 100% rename from docs/layouts/partials/css.html rename to docs/website/layouts/partials/css.html diff --git a/docs/layouts/partials/docs/article.html b/docs/website/layouts/partials/docs/article.html similarity index 100% rename from docs/layouts/partials/docs/article.html rename to docs/website/layouts/partials/docs/article.html diff --git a/docs/layouts/partials/docs/dashboard.html b/docs/website/layouts/partials/docs/dashboard.html similarity index 100% rename from docs/layouts/partials/docs/dashboard.html rename to docs/website/layouts/partials/docs/dashboard.html diff --git a/docs/layouts/partials/docs/hero.html b/docs/website/layouts/partials/docs/hero.html similarity index 100% rename from docs/layouts/partials/docs/hero.html rename to docs/website/layouts/partials/docs/hero.html diff --git a/docs/layouts/partials/docs/navbar.html b/docs/website/layouts/partials/docs/navbar.html similarity index 100% rename from docs/layouts/partials/docs/navbar.html rename to docs/website/layouts/partials/docs/navbar.html diff --git a/docs/layouts/partials/docs/sidenav.html b/docs/website/layouts/partials/docs/sidenav.html similarity index 100% rename from docs/layouts/partials/docs/sidenav.html rename to docs/website/layouts/partials/docs/sidenav.html diff --git a/docs/layouts/partials/docs/sidenav/production.html b/docs/website/layouts/partials/docs/sidenav/production.html similarity index 100% rename from docs/layouts/partials/docs/sidenav/production.html rename to docs/website/layouts/partials/docs/sidenav/production.html diff --git a/docs/layouts/partials/google-analytics.html b/docs/website/layouts/partials/google-analytics.html similarity index 100% rename from docs/layouts/partials/google-analytics.html rename to docs/website/layouts/partials/google-analytics.html diff --git a/docs/layouts/partials/home/banner.html b/docs/website/layouts/partials/home/banner.html similarity index 100% rename from docs/layouts/partials/home/banner.html rename to docs/website/layouts/partials/home/banner.html diff --git a/docs/layouts/partials/home/footer.html b/docs/website/layouts/partials/home/footer.html similarity index 100% rename from docs/layouts/partials/home/footer.html rename to docs/website/layouts/partials/home/footer.html diff --git a/docs/layouts/partials/home/svg.html b/docs/website/layouts/partials/home/svg.html similarity index 100% rename from docs/layouts/partials/home/svg.html rename to docs/website/layouts/partials/home/svg.html diff --git a/docs/layouts/partials/home/traits.html b/docs/website/layouts/partials/home/traits.html similarity index 100% rename from docs/layouts/partials/home/traits.html rename to docs/website/layouts/partials/home/traits.html diff --git a/docs/layouts/partials/home/use-cases.html b/docs/website/layouts/partials/home/use-cases.html similarity index 100% rename from docs/layouts/partials/home/use-cases.html rename to docs/website/layouts/partials/home/use-cases.html diff --git a/docs/layouts/partials/javascript.html b/docs/website/layouts/partials/javascript.html similarity index 100% rename from docs/layouts/partials/javascript.html rename to docs/website/layouts/partials/javascript.html diff --git a/docs/layouts/partials/meta.html b/docs/website/layouts/partials/meta.html similarity index 100% rename from docs/layouts/partials/meta.html rename to docs/website/layouts/partials/meta.html diff --git a/docs/layouts/shortcodes/code.html b/docs/website/layouts/shortcodes/code.html similarity index 100% rename from docs/layouts/shortcodes/code.html rename to docs/website/layouts/shortcodes/code.html diff --git a/docs/layouts/shortcodes/figure.html b/docs/website/layouts/shortcodes/figure.html similarity index 100% rename from docs/layouts/shortcodes/figure.html rename to docs/website/layouts/shortcodes/figure.html diff --git a/docs/layouts/shortcodes/latest.html b/docs/website/layouts/shortcodes/latest.html similarity index 100% rename from docs/layouts/shortcodes/latest.html rename to docs/website/layouts/shortcodes/latest.html diff --git a/docs/node_modules/bulma/CHANGELOG.md b/docs/website/node_modules/bulma/CHANGELOG.md similarity index 100% rename from docs/node_modules/bulma/CHANGELOG.md rename to docs/website/node_modules/bulma/CHANGELOG.md diff --git a/docs/node_modules/bulma/LICENSE b/docs/website/node_modules/bulma/LICENSE similarity index 100% rename from docs/node_modules/bulma/LICENSE rename to docs/website/node_modules/bulma/LICENSE diff --git a/docs/node_modules/bulma/README.md b/docs/website/node_modules/bulma/README.md similarity index 100% rename from docs/node_modules/bulma/README.md rename to docs/website/node_modules/bulma/README.md diff --git a/docs/node_modules/bulma/bulma.sass b/docs/website/node_modules/bulma/bulma.sass similarity index 100% rename from docs/node_modules/bulma/bulma.sass rename to docs/website/node_modules/bulma/bulma.sass diff --git a/docs/node_modules/bulma/css/bulma.css b/docs/website/node_modules/bulma/css/bulma.css similarity index 100% rename from docs/node_modules/bulma/css/bulma.css rename to docs/website/node_modules/bulma/css/bulma.css diff --git a/docs/node_modules/bulma/css/bulma.css.map b/docs/website/node_modules/bulma/css/bulma.css.map similarity index 100% rename from docs/node_modules/bulma/css/bulma.css.map rename to docs/website/node_modules/bulma/css/bulma.css.map diff --git a/docs/node_modules/bulma/css/bulma.min.css b/docs/website/node_modules/bulma/css/bulma.min.css similarity index 100% rename from docs/node_modules/bulma/css/bulma.min.css rename to docs/website/node_modules/bulma/css/bulma.min.css diff --git a/docs/node_modules/bulma/package.json b/docs/website/node_modules/bulma/package.json similarity index 100% rename from docs/node_modules/bulma/package.json rename to docs/website/node_modules/bulma/package.json diff --git a/docs/node_modules/bulma/sass/base/_all.sass b/docs/website/node_modules/bulma/sass/base/_all.sass similarity index 100% rename from docs/node_modules/bulma/sass/base/_all.sass rename to docs/website/node_modules/bulma/sass/base/_all.sass diff --git a/docs/node_modules/bulma/sass/base/generic.sass b/docs/website/node_modules/bulma/sass/base/generic.sass similarity index 100% rename from docs/node_modules/bulma/sass/base/generic.sass rename to docs/website/node_modules/bulma/sass/base/generic.sass diff --git a/docs/node_modules/bulma/sass/base/helpers.sass b/docs/website/node_modules/bulma/sass/base/helpers.sass similarity index 100% rename from docs/node_modules/bulma/sass/base/helpers.sass rename to docs/website/node_modules/bulma/sass/base/helpers.sass diff --git a/docs/node_modules/bulma/sass/base/minireset.sass b/docs/website/node_modules/bulma/sass/base/minireset.sass similarity index 100% rename from docs/node_modules/bulma/sass/base/minireset.sass rename to docs/website/node_modules/bulma/sass/base/minireset.sass diff --git a/docs/node_modules/bulma/sass/components/_all.sass b/docs/website/node_modules/bulma/sass/components/_all.sass similarity index 100% rename from docs/node_modules/bulma/sass/components/_all.sass rename to docs/website/node_modules/bulma/sass/components/_all.sass diff --git a/docs/node_modules/bulma/sass/components/breadcrumb.sass b/docs/website/node_modules/bulma/sass/components/breadcrumb.sass similarity index 100% rename from docs/node_modules/bulma/sass/components/breadcrumb.sass rename to docs/website/node_modules/bulma/sass/components/breadcrumb.sass diff --git a/docs/node_modules/bulma/sass/components/card.sass b/docs/website/node_modules/bulma/sass/components/card.sass similarity index 100% rename from docs/node_modules/bulma/sass/components/card.sass rename to docs/website/node_modules/bulma/sass/components/card.sass diff --git a/docs/node_modules/bulma/sass/components/dropdown.sass b/docs/website/node_modules/bulma/sass/components/dropdown.sass similarity index 100% rename from docs/node_modules/bulma/sass/components/dropdown.sass rename to docs/website/node_modules/bulma/sass/components/dropdown.sass diff --git a/docs/node_modules/bulma/sass/components/level.sass b/docs/website/node_modules/bulma/sass/components/level.sass similarity index 100% rename from docs/node_modules/bulma/sass/components/level.sass rename to docs/website/node_modules/bulma/sass/components/level.sass diff --git a/docs/node_modules/bulma/sass/components/list.sass b/docs/website/node_modules/bulma/sass/components/list.sass similarity index 100% rename from docs/node_modules/bulma/sass/components/list.sass rename to docs/website/node_modules/bulma/sass/components/list.sass diff --git a/docs/node_modules/bulma/sass/components/media.sass b/docs/website/node_modules/bulma/sass/components/media.sass similarity index 100% rename from docs/node_modules/bulma/sass/components/media.sass rename to docs/website/node_modules/bulma/sass/components/media.sass diff --git a/docs/node_modules/bulma/sass/components/menu.sass b/docs/website/node_modules/bulma/sass/components/menu.sass similarity index 100% rename from docs/node_modules/bulma/sass/components/menu.sass rename to docs/website/node_modules/bulma/sass/components/menu.sass diff --git a/docs/node_modules/bulma/sass/components/message.sass b/docs/website/node_modules/bulma/sass/components/message.sass similarity index 100% rename from docs/node_modules/bulma/sass/components/message.sass rename to docs/website/node_modules/bulma/sass/components/message.sass diff --git a/docs/node_modules/bulma/sass/components/modal.sass b/docs/website/node_modules/bulma/sass/components/modal.sass similarity index 100% rename from docs/node_modules/bulma/sass/components/modal.sass rename to docs/website/node_modules/bulma/sass/components/modal.sass diff --git a/docs/node_modules/bulma/sass/components/navbar.sass b/docs/website/node_modules/bulma/sass/components/navbar.sass similarity index 100% rename from docs/node_modules/bulma/sass/components/navbar.sass rename to docs/website/node_modules/bulma/sass/components/navbar.sass diff --git a/docs/node_modules/bulma/sass/components/pagination.sass b/docs/website/node_modules/bulma/sass/components/pagination.sass similarity index 100% rename from docs/node_modules/bulma/sass/components/pagination.sass rename to docs/website/node_modules/bulma/sass/components/pagination.sass diff --git a/docs/node_modules/bulma/sass/components/panel.sass b/docs/website/node_modules/bulma/sass/components/panel.sass similarity index 100% rename from docs/node_modules/bulma/sass/components/panel.sass rename to docs/website/node_modules/bulma/sass/components/panel.sass diff --git a/docs/node_modules/bulma/sass/components/tabs.sass b/docs/website/node_modules/bulma/sass/components/tabs.sass similarity index 100% rename from docs/node_modules/bulma/sass/components/tabs.sass rename to docs/website/node_modules/bulma/sass/components/tabs.sass diff --git a/docs/node_modules/bulma/sass/elements/_all.sass b/docs/website/node_modules/bulma/sass/elements/_all.sass similarity index 100% rename from docs/node_modules/bulma/sass/elements/_all.sass rename to docs/website/node_modules/bulma/sass/elements/_all.sass diff --git a/docs/node_modules/bulma/sass/elements/box.sass b/docs/website/node_modules/bulma/sass/elements/box.sass similarity index 100% rename from docs/node_modules/bulma/sass/elements/box.sass rename to docs/website/node_modules/bulma/sass/elements/box.sass diff --git a/docs/node_modules/bulma/sass/elements/button.sass b/docs/website/node_modules/bulma/sass/elements/button.sass similarity index 100% rename from docs/node_modules/bulma/sass/elements/button.sass rename to docs/website/node_modules/bulma/sass/elements/button.sass diff --git a/docs/node_modules/bulma/sass/elements/container.sass b/docs/website/node_modules/bulma/sass/elements/container.sass similarity index 100% rename from docs/node_modules/bulma/sass/elements/container.sass rename to docs/website/node_modules/bulma/sass/elements/container.sass diff --git a/docs/node_modules/bulma/sass/elements/content.sass b/docs/website/node_modules/bulma/sass/elements/content.sass similarity index 100% rename from docs/node_modules/bulma/sass/elements/content.sass rename to docs/website/node_modules/bulma/sass/elements/content.sass diff --git a/docs/node_modules/bulma/sass/elements/form.sass b/docs/website/node_modules/bulma/sass/elements/form.sass similarity index 100% rename from docs/node_modules/bulma/sass/elements/form.sass rename to docs/website/node_modules/bulma/sass/elements/form.sass diff --git a/docs/node_modules/bulma/sass/elements/icon.sass b/docs/website/node_modules/bulma/sass/elements/icon.sass similarity index 100% rename from docs/node_modules/bulma/sass/elements/icon.sass rename to docs/website/node_modules/bulma/sass/elements/icon.sass diff --git a/docs/node_modules/bulma/sass/elements/image.sass b/docs/website/node_modules/bulma/sass/elements/image.sass similarity index 100% rename from docs/node_modules/bulma/sass/elements/image.sass rename to docs/website/node_modules/bulma/sass/elements/image.sass diff --git a/docs/node_modules/bulma/sass/elements/notification.sass b/docs/website/node_modules/bulma/sass/elements/notification.sass similarity index 100% rename from docs/node_modules/bulma/sass/elements/notification.sass rename to docs/website/node_modules/bulma/sass/elements/notification.sass diff --git a/docs/node_modules/bulma/sass/elements/other.sass b/docs/website/node_modules/bulma/sass/elements/other.sass similarity index 100% rename from docs/node_modules/bulma/sass/elements/other.sass rename to docs/website/node_modules/bulma/sass/elements/other.sass diff --git a/docs/node_modules/bulma/sass/elements/progress.sass b/docs/website/node_modules/bulma/sass/elements/progress.sass similarity index 100% rename from docs/node_modules/bulma/sass/elements/progress.sass rename to docs/website/node_modules/bulma/sass/elements/progress.sass diff --git a/docs/node_modules/bulma/sass/elements/table.sass b/docs/website/node_modules/bulma/sass/elements/table.sass similarity index 100% rename from docs/node_modules/bulma/sass/elements/table.sass rename to docs/website/node_modules/bulma/sass/elements/table.sass diff --git a/docs/node_modules/bulma/sass/elements/tag.sass b/docs/website/node_modules/bulma/sass/elements/tag.sass similarity index 100% rename from docs/node_modules/bulma/sass/elements/tag.sass rename to docs/website/node_modules/bulma/sass/elements/tag.sass diff --git a/docs/node_modules/bulma/sass/elements/title.sass b/docs/website/node_modules/bulma/sass/elements/title.sass similarity index 100% rename from docs/node_modules/bulma/sass/elements/title.sass rename to docs/website/node_modules/bulma/sass/elements/title.sass diff --git a/docs/node_modules/bulma/sass/grid/_all.sass b/docs/website/node_modules/bulma/sass/grid/_all.sass similarity index 100% rename from docs/node_modules/bulma/sass/grid/_all.sass rename to docs/website/node_modules/bulma/sass/grid/_all.sass diff --git a/docs/node_modules/bulma/sass/grid/columns.sass b/docs/website/node_modules/bulma/sass/grid/columns.sass similarity index 100% rename from docs/node_modules/bulma/sass/grid/columns.sass rename to docs/website/node_modules/bulma/sass/grid/columns.sass diff --git a/docs/node_modules/bulma/sass/grid/tiles.sass b/docs/website/node_modules/bulma/sass/grid/tiles.sass similarity index 100% rename from docs/node_modules/bulma/sass/grid/tiles.sass rename to docs/website/node_modules/bulma/sass/grid/tiles.sass diff --git a/docs/node_modules/bulma/sass/layout/_all.sass b/docs/website/node_modules/bulma/sass/layout/_all.sass similarity index 100% rename from docs/node_modules/bulma/sass/layout/_all.sass rename to docs/website/node_modules/bulma/sass/layout/_all.sass diff --git a/docs/node_modules/bulma/sass/layout/footer.sass b/docs/website/node_modules/bulma/sass/layout/footer.sass similarity index 100% rename from docs/node_modules/bulma/sass/layout/footer.sass rename to docs/website/node_modules/bulma/sass/layout/footer.sass diff --git a/docs/node_modules/bulma/sass/layout/hero.sass b/docs/website/node_modules/bulma/sass/layout/hero.sass similarity index 100% rename from docs/node_modules/bulma/sass/layout/hero.sass rename to docs/website/node_modules/bulma/sass/layout/hero.sass diff --git a/docs/node_modules/bulma/sass/layout/section.sass b/docs/website/node_modules/bulma/sass/layout/section.sass similarity index 100% rename from docs/node_modules/bulma/sass/layout/section.sass rename to docs/website/node_modules/bulma/sass/layout/section.sass diff --git a/docs/node_modules/bulma/sass/utilities/_all.sass b/docs/website/node_modules/bulma/sass/utilities/_all.sass similarity index 100% rename from docs/node_modules/bulma/sass/utilities/_all.sass rename to docs/website/node_modules/bulma/sass/utilities/_all.sass diff --git a/docs/node_modules/bulma/sass/utilities/animations.sass b/docs/website/node_modules/bulma/sass/utilities/animations.sass similarity index 100% rename from docs/node_modules/bulma/sass/utilities/animations.sass rename to docs/website/node_modules/bulma/sass/utilities/animations.sass diff --git a/docs/node_modules/bulma/sass/utilities/controls.sass b/docs/website/node_modules/bulma/sass/utilities/controls.sass similarity index 100% rename from docs/node_modules/bulma/sass/utilities/controls.sass rename to docs/website/node_modules/bulma/sass/utilities/controls.sass diff --git a/docs/node_modules/bulma/sass/utilities/derived-variables.sass b/docs/website/node_modules/bulma/sass/utilities/derived-variables.sass similarity index 100% rename from docs/node_modules/bulma/sass/utilities/derived-variables.sass rename to docs/website/node_modules/bulma/sass/utilities/derived-variables.sass diff --git a/docs/node_modules/bulma/sass/utilities/functions.sass b/docs/website/node_modules/bulma/sass/utilities/functions.sass similarity index 100% rename from docs/node_modules/bulma/sass/utilities/functions.sass rename to docs/website/node_modules/bulma/sass/utilities/functions.sass diff --git a/docs/node_modules/bulma/sass/utilities/initial-variables.sass b/docs/website/node_modules/bulma/sass/utilities/initial-variables.sass similarity index 100% rename from docs/node_modules/bulma/sass/utilities/initial-variables.sass rename to docs/website/node_modules/bulma/sass/utilities/initial-variables.sass diff --git a/docs/node_modules/bulma/sass/utilities/mixins.sass b/docs/website/node_modules/bulma/sass/utilities/mixins.sass similarity index 100% rename from docs/node_modules/bulma/sass/utilities/mixins.sass rename to docs/website/node_modules/bulma/sass/utilities/mixins.sass diff --git a/docs/package-lock.json b/docs/website/package-lock.json similarity index 100% rename from docs/package-lock.json rename to docs/website/package-lock.json diff --git a/docs/package.json b/docs/website/package.json similarity index 100% rename from docs/package.json rename to docs/website/package.json diff --git a/docs/scripts/load-docs.sh b/docs/website/scripts/load-docs.sh similarity index 89% rename from docs/scripts/load-docs.sh rename to docs/website/scripts/load-docs.sh index f24df6be50..79ff69c908 100755 --- a/docs/scripts/load-docs.sh +++ b/docs/website/scripts/load-docs.sh @@ -2,8 +2,6 @@ set -xe -RELEASES=$(cat RELEASES) - ORIGINAL_COMMIT=$(git name-rev --name-only HEAD) # If no name can be found "git name-rev" returns # "undefined", in which case we'll just use the @@ -13,9 +11,11 @@ if [[ "${ORIGINAL_COMMIT}" == "undefined" ]]; then fi ROOT_DIR=$(git rev-parse --show-toplevel) -RELEASES_YAML_FILE=${ROOT_DIR}/docs/data/releases.yaml +RELEASES_YAML_FILE=${ROOT_DIR}/docs/website/data/releases.yaml GIT_VERSION=$(git --version) +RELEASES=$(cat ${ROOT_DIR}/docs/website/RELEASES) + echo "Git version: ${GIT_VERSION}" echo "Saving current workspace state" @@ -49,13 +49,13 @@ function cleanup { trap cleanup EXIT echo "Cleaning generated folder" -rm -rf ${ROOT_DIR}/docs/generated/* +rm -rf ${ROOT_DIR}/docs/website/generated/* echo "Removing data/releases.yaml file" rm -f ${RELEASES_YAML_FILE} for release in ${RELEASES}; do - version_docs_dir=${ROOT_DIR}/docs/generated/docs/${release} + version_docs_dir=${ROOT_DIR}/docs/website/generated/docs/${release} mkdir -p ${version_docs_dir} @@ -75,6 +75,7 @@ for release in ${RELEASES}; do # if we were able to check out the version, otherwise skip it.. if [[ "${errc}" == "0" ]]; then echo "Adding ${release} to releases.yaml" + mkdir -p $(dirname ${RELEASES_YAML_FILE}) echo "- ${release}" >> ${RELEASES_YAML_FILE} else echo "WARNING: Failed to check out version ${version}!!" @@ -102,4 +103,4 @@ echo "- edge" >> ${RELEASES_YAML_FILE} # Link instead of copy so we don't need to re-generate each time. # Use a relative link so it works in a container more easily. -ln -s ../../content ${ROOT_DIR}/docs/generated/docs/edge +ln -s ../../../content ${ROOT_DIR}/docs/website/generated/docs/edge diff --git a/docs/static/css/home.css b/docs/website/static/css/home.css similarity index 100% rename from docs/static/css/home.css rename to docs/website/static/css/home.css diff --git a/docs/static/favicon.png b/docs/website/static/favicon.png similarity index 100% rename from docs/static/favicon.png rename to docs/website/static/favicon.png diff --git a/docs/static/img/Github.svg b/docs/website/static/img/Github.svg similarity index 100% rename from docs/static/img/Github.svg rename to docs/website/static/img/Github.svg diff --git a/docs/static/img/Medium.svg b/docs/website/static/img/Medium.svg similarity index 100% rename from docs/static/img/Medium.svg rename to docs/website/static/img/Medium.svg diff --git a/docs/static/img/Slack.svg b/docs/website/static/img/Slack.svg similarity index 100% rename from docs/static/img/Slack.svg rename to docs/website/static/img/Slack.svg diff --git a/docs/static/img/api-authorization.svg b/docs/website/static/img/api-authorization.svg similarity index 100% rename from docs/static/img/api-authorization.svg rename to docs/website/static/img/api-authorization.svg diff --git a/docs/static/img/boat.svg b/docs/website/static/img/boat.svg similarity index 100% rename from docs/static/img/boat.svg rename to docs/website/static/img/boat.svg diff --git a/docs/static/img/cloud.svg b/docs/website/static/img/cloud.svg similarity index 100% rename from docs/static/img/cloud.svg rename to docs/website/static/img/cloud.svg diff --git a/docs/static/img/context-icon.svg b/docs/website/static/img/context-icon.svg similarity index 100% rename from docs/static/img/context-icon.svg rename to docs/website/static/img/context-icon.svg diff --git a/docs/static/img/declarative-icon.svg b/docs/website/static/img/declarative-icon.svg similarity index 100% rename from docs/static/img/declarative-icon.svg rename to docs/website/static/img/declarative-icon.svg diff --git a/docs/static/img/kubernetes-admission-control.svg b/docs/website/static/img/kubernetes-admission-control.svg similarity index 100% rename from docs/static/img/kubernetes-admission-control.svg rename to docs/website/static/img/kubernetes-admission-control.svg diff --git a/docs/static/img/logos/opa-horizontal-color.png b/docs/website/static/img/logos/opa-horizontal-color.png similarity index 100% rename from docs/static/img/logos/opa-horizontal-color.png rename to docs/website/static/img/logos/opa-horizontal-color.png diff --git a/docs/static/img/logos/opa-icon-white.png b/docs/website/static/img/logos/opa-icon-white.png similarity index 100% rename from docs/static/img/logos/opa-icon-white.png rename to docs/website/static/img/logos/opa-icon-white.png diff --git a/docs/static/img/logos/opa-stacked-color.png b/docs/website/static/img/logos/opa-stacked-color.png similarity index 100% rename from docs/static/img/logos/opa-stacked-color.png rename to docs/website/static/img/logos/opa-stacked-color.png diff --git a/docs/static/img/opa-logo.svg b/docs/website/static/img/opa-logo.svg similarity index 100% rename from docs/static/img/opa-logo.svg rename to docs/website/static/img/opa-logo.svg diff --git a/docs/static/img/partial-evaluation.svg b/docs/website/static/img/partial-evaluation.svg similarity index 100% rename from docs/static/img/partial-evaluation.svg rename to docs/website/static/img/partial-evaluation.svg diff --git a/docs/static/img/sea-plants.svg b/docs/website/static/img/sea-plants.svg similarity index 100% rename from docs/static/img/sea-plants.svg rename to docs/website/static/img/sea-plants.svg diff --git a/docs/static/img/ssh-authorization.svg b/docs/website/static/img/ssh-authorization.svg similarity index 100% rename from docs/static/img/ssh-authorization.svg rename to docs/website/static/img/ssh-authorization.svg diff --git a/docs/static/img/unified-icon.svg b/docs/website/static/img/unified-icon.svg similarity index 100% rename from docs/static/img/unified-icon.svg rename to docs/website/static/img/unified-icon.svg diff --git a/docs/static/img/viking-village.svg b/docs/website/static/img/viking-village.svg similarity index 100% rename from docs/static/img/viking-village.svg rename to docs/website/static/img/viking-village.svg diff --git a/docs/static/img/wave--examples.svg b/docs/website/static/img/wave--examples.svg similarity index 100% rename from docs/static/img/wave--examples.svg rename to docs/website/static/img/wave--examples.svg diff --git a/docs/static/img/wave--headline--bg.svg b/docs/website/static/img/wave--headline--bg.svg similarity index 100% rename from docs/static/img/wave--headline--bg.svg rename to docs/website/static/img/wave--headline--bg.svg diff --git a/docs/static/img/wave--headline--fg.svg b/docs/website/static/img/wave--headline--fg.svg similarity index 100% rename from docs/static/img/wave--headline--fg.svg rename to docs/website/static/img/wave--headline--fg.svg diff --git a/docs/static/img/wave--use-cases.svg b/docs/website/static/img/wave--use-cases.svg similarity index 100% rename from docs/static/img/wave--use-cases.svg rename to docs/website/static/img/wave--use-cases.svg diff --git a/docs/static/js/home.js b/docs/website/static/js/home.js similarity index 100% rename from docs/static/js/home.js rename to docs/website/static/js/home.js diff --git a/netlify.toml b/netlify.toml index 03492270cf..334daf4c2e 100644 --- a/netlify.toml +++ b/netlify.toml @@ -1,5 +1,5 @@ [build] -publish = "docs/public" +publish = "docs/website/public" command = "make docs-production-build" [build.environment] @@ -17,5 +17,5 @@ command = "make docs-preview-build" # NOTE: The command is from the root of the repo, not # the "base" directory. command = "make docs-hugo-serve" -publish = "docs/public" +publish = "docs/website/public" port = 1313