Skip to content
This repository has been archived by the owner on Jun 26, 2024. It is now read-only.

Commit

Permalink
Enable site generation using GitHub sources as well as local files. (#…
Browse files Browse the repository at this point in the history
…1145)

Signed-off-by: Pavel Macík <[email protected]>
  • Loading branch information
pmacik authored May 17, 2022
1 parent 93a55b4 commit 61b68c9
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .github/workflows/merge-to-master.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,8 @@ jobs:
uses: actions/checkout@v2

- name: generate website
env:
SITE_SOURCE: github
run: |
make site
touch ./out/site/.nojekyll
Expand Down
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ OUTPUT_DIR ?= $(shell echo ${PWD})/out
GOLANGCI_LINT_BIN=$(OUTPUT_DIR)/golangci-lint
PYTHON_VENV_DIR=$(OUTPUT_DIR)/venv3

# Source for generating docs (one of `local` and `github`)
SITE_SOURCE ?= local

CONTAINER_RUNTIME ?= docker

QUAY_USERNAME ?= redhat-developer+travis
Expand Down Expand Up @@ -334,7 +337,7 @@ clean:
.PHONY: site
## render site
site:
$(CONTAINER_RUNTIME) run -u $(shell id -u) -e CI=true -e HOME=/antora -v ${PWD}:/antora:Z --rm -t antora/antora:3.0.1 antora-playbook.yaml
$(CONTAINER_RUNTIME) run -u $(shell id -u) -e CI=true -e HOME=/antora -v ${PWD}:/antora:Z --rm -t antora/antora:3.0.1 antora-playbook.$(SITE_SOURCE).yaml

.PHONY: test-performance-setup
## Setup OpenShift cluster for performance test
Expand Down
22 changes: 22 additions & 0 deletions antora-playbook.github.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
site:
title: Service Binding Operator Documentation
url: https://redhat-developer.github.io/service-binding-operator
start_page: userguide::intro.adoc
content:
sources:
- branches: HEAD
start_paths: docs/userguide, docs/devguide
url: https://github.com/redhat-developer/service-binding-operator
- branches: v1.0.1
start_paths: docs/userguide, docs/devguide
url: https://github.com/redhat-developer/service-binding-operator
- branches: v1.0.0
start_paths: docs/userguide
url: https://github.com/redhat-developer/service-binding-operator
ui:
bundle:
url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable
snapshot: true
supplemental_files: ./hack/antora
output:
dir: ./out/site
File renamed without changes.

0 comments on commit 61b68c9

Please sign in to comment.