Skip to content

vshn/component-appcat

Commodore Component: appcat

This is a Commodore Component for appcat.

This repository is part of Project Syn. For documentation on Project Syn and this component, see https://syn.tools.

Getting started for developers

This repository contains:

  • component: SYN Commodore component for installing AppCat features

This component can be compiled with commodore like this:

$ commodore component compile . --search-paths . -n appcat -f tests/defaults.yml
#
# Alternative:
#
$ make test

The resulting compiled component can be found in compiled/.

There is currently no easy way to run it locally. You need to apply the compiled component to a test cluster to see if it works as expected.

This process is not suitable for installing the component on a production system.

Documentation

The rendered documentation for this component is available on the Commodore Components Hub.

Documentation for this component is written using Asciidoc and Antora. It's located in the docs/ folder. The Divio documentation structure 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 lint_adoc command and correct any warnings raised by the tool.

Contributing and license

This library is licensed under BSD-3-Clause. For information about how to contribute see CONTRIBUTING.