Skip to content
This repository was archived by the owner on Mar 4, 2024. It is now read-only.

Conversation

@ccremer
Copy link
Contributor

@ccremer ccremer commented Jan 4, 2022

Summary

  • Adds Antora documentation module (opt-out)
  • Adds Make targets for local preview
  • Adds Make target also for easy deployment to GitHub Pages (opt-out file-wise, opt-in because first the gh-pages branch has to be created before GH Pages is active)

Note: The included playbook is for GH pages. The Antora module can also be built externally with existing VSHN's Antora playbooks.

Checklist

  • Categorize the PR by setting a good title and adding one of the labels:
    bug, enhancement, documentation, change, breaking, dependency
    as they show up in the changelog
  • Update tests.

@ccremer ccremer added the enhancement New feature or request label Jan 4, 2022
@ccremer ccremer force-pushed the antora-docs branch 2 times, most recently from 1915d6b to 297bc92 Compare January 5, 2022 10:49
@ccremer ccremer force-pushed the antora-docs branch 3 times, most recently from 8d26415 to 2a1f64d Compare January 5, 2022 11:05
@ccremer ccremer requested a review from bastjan January 5, 2022 11:29
@ccremer ccremer marked this pull request as ready for review January 5, 2022 11:29
@ccremer ccremer requested a review from tobru January 5, 2022 11:30
@ccremer
Copy link
Contributor Author

ccremer commented Jan 5, 2022

So far K8up is the only Go-based software repo where we included Antora documentation module AFAIK.
I added this Antora scaffold to this template to help prepare specific documentation for a software component.
For example, to document upcoming Odoo-specific adapter for APPUiO Cloud

@ccremer ccremer merged commit 0d28a80 into master Jan 6, 2022
@ccremer ccremer deleted the antora-docs branch January 6, 2022 08:50
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants