Merge pull request #36 from appuio/modulesync-1a5bc9f

[ModuleSync] Update from projectsyn/modulesync-control@1a5bc9f

Author: simu

.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

README.md

@@ -1,21 +1,27 @@
 # Commodore Component: OpenShift4 Console
 
-This is a [Commodore][commodore] Component to manage the OpenShift4 Console.
+This is a [Commodore][commodore] Component for OpenShift4 Console.
 
 This repository is part of Project Syn.
 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/openshift4-console).
+
 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.
 
+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.
+
+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/

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: openshift4-console