diff --git a/.gitignore b/.gitignore index b0576006..6108dd45 100644 --- a/.gitignore +++ b/.gitignore @@ -5,16 +5,16 @@ # # Commodore -.cache/ -helmcharts/ -manifests/ -vendor/ -jsonnetfile.lock.json -crds/ -compiled/ +/.cache +/helmcharts +/manifests +/vendor +/jsonnetfile.lock.json +/crds +/compiled # Antora -_archive/ -_public/ +/_archive +/_public # Additional entries diff --git a/README.md b/README.md index 9242ec2b..242db268 100644 --- a/README.md +++ b/README.md @@ -7,20 +7,21 @@ For documentation on Project Syn and this component, see https://syn.tools. ## Documentation +The rendered documentation for this component is available on the [Commodore Components Hub](https://hub.syn.tools/cert-manager). + Documentation for this component is written using [Asciidoc][asciidoc] and [Antora][antora]. It is located in the [docs/](docs) folder. The [Divio documentation structure](https://documentation.divio.com/) is used to organize its content. -## Known issues +Run the `make docs-serve` command in the root of the project, and then browse to http://localhost:2020 to see a preview of the current state of the documentation. -- The chart uses the clusters api version to decide which version of CRDs to install. - When using `helm template`, the chart will install CRDs named legacy (see [issue #543](https://github.com/deepmind/kapitan/issues/543)). +After writing the documentation, please use the `make docs-vale` command and correct any warnings raised by the tool. ## Contributing and license This library is licensed under [BSD-3-Clause](LICENSE). For information about how to contribute see [CONTRIBUTING](CONTRIBUTING.md). -[commodore]: https://docs.syn.tools/commodore/index.html +[commodore]: https://syn.tools/commodore/ [asciidoc]: https://asciidoctor.org/ [antora]: https://antora.org/ diff --git a/docs/antora.yml b/docs/antora.yml index 80ddd8bc..ebbdb576 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -1,7 +1,9 @@ # # File managed by ModuleSync - Do Not Edit # -# The name and title can be customized in `.sync.yml` with `'docs/antora.yml'.title`, `'docs/antora.yml'.name` +# The title can be customized in `.sync.yml` with `:global.componentName` +# The name is generated from the component's GitHub repository name, with the +# `component-` prefix removed. # name: cert-manager