Make targets and github workflow for publishing docs #23
Conversation
|
Skipping CI for Draft Pull Request. |
raukadah
force-pushed
the
docs_publish
branch
2 times, most recently
from
93423e7 to
8f00d00
Compare
raukadah
requested review from
amoralej and
SeanMooney
and removed request for
olliewalsh
raukadah
force-pushed
the
docs_publish
branch
3 times, most recently
from
0feff09 to
6318e68
Compare
docs/Makefile
Outdated
| open-html: html | ||
| ${BROWSER_OPEN} "file://$(realpath $(ROOTDIR)/$(DEST_HTML))" | ||
|
|
||
| open-pdf: pdf |
There was a problem hiding this comment.
is this one redundant we aren't wiring it up anywhere
docs/Makefile
Outdated
| $(BUNDLE_EXEC) asciidoctor -a source-highlighter=highlightjs -a highlightjs-languages="yaml,bash" -a highlightjs-theme="monokai" --failure-level WARN -b xhtml5 -d book -o $@ $(MAIN_SOURCE) | ||
|
|
||
| $(DEST_PDF): $(ALL_SOURCES) | ||
| $(BUNDLE_EXEC) asciidoctor-pdf -d book -o $@ $(MAIN_SOURCE) $(IMAGES) |
There was a problem hiding this comment.
same i think remove this one? besides not calling the open-pdf we are also commenting out the asciidoctor-pdf gem
raukadah
force-pushed
the
docs_publish
branch
from
6318e68 to
47e7907
Compare
|
Build failed (check pipeline). Post https://softwarefactory-project.io/zuul/t/rdoproject.org/buildset/26bb4d4e24a64a2087a42d669b1598d6 ✔️ noop SUCCESS in 0s |
Gemfile
Outdated
| gem 'asciidoctor', '~> 2.0', '>= 2.0.20' | ||
|
|
||
| # Uncomment for ability to render pdf: | ||
| # gem 'asciidoctor-pdf', '~> 2.0', '>= 2.0.20' |
There was a problem hiding this comment.
Any reason we are leaving the pdf commented and removing all the pdf but leaving 'Markdown to AsciiDoc' below? Comparing with https://github.com/openstack-k8s-operators/data-plane-adoption/blob/main/Gemfile
There was a problem hiding this comment.
It is commented in https://github.com/openstack-k8s-operators/openstack-operator/blob/main/Gemfile#L6 so I left it as it is.
There was a problem hiding this comment.
Dropped the commented piece from Gemfile as asciidoctor-pdf is not used in the existing make target.
raukadah
force-pushed
the
docs_publish
branch
from
47e7907 to
36651b2
Compare
docs/Makefile
Outdated
|
|
||
| html-latest: prepare $(IMAGES_TS) $(DEST_HTML) | ||
|
|
||
| pdf: prepare $(DEST_PDF) |
docs/Makefile
Outdated
| @mkdir -p $(DEST_DIR) $(IMAGES_DIR) | ||
|
|
||
| clean: | ||
| @rm -rf "$(DEST_DIR)" "$(DEST_PDF)" |
There was a problem hiding this comment.
i think we should remove this reference too DEST_PDF?
This pr adds: - Make docs to build the docs using ascii * Install ascii doc ruby packages using bundle * Convert README.md to main.adoc * Use Make target to build html files - Github action to build and publish docs on github pages. - Zuul job to preview docs Signed-off-by: Chandan Kumar <[email protected]>
raukadah
force-pushed
the
docs_publish
branch
from
36651b2 to
fc93553
Compare
|
/lgtm |
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: amoralej The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-merge-bot
bot
merged commit 214e8bd
into
openstack-k8s-operators:main
This pr adds:
Generated doc from Zuul Job: https://logserver.rdoproject.org/23/23/0feff09f3ebf811cca55fbdabc3c3efe51325011/github-check/watcher-operator-doc-preview/e7e85aa/docs_build/docs_build/watcher-operator/