https://github.com/appuio/component-machineset-egress-cidr-operator

This is a Commodore Component for openshift-machineset-egress-cidr-operator.
https://github.com/appuio/component-machineset-egress-cidr-operator

commodore commodore-component openshift projectsyn syn

Last synced: 6 days ago
JSON representation

This is a Commodore Component for openshift-machineset-egress-cidr-operator.

• Host: GitHub
• URL: https://github.com/appuio/component-machineset-egress-cidr-operator
• Owner: appuio
• License: bsd-3-clause
• Created: 2021-06-21T14:20:52.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-08T14:34:29.000Z (5 months ago)
• Last Synced: 2024-08-08T17:04:50.055Z (5 months ago)
• Topics: commodore, commodore-component, openshift, projectsyn, syn
• Language: Makefile
• Homepage: https://appuio.ch
• Size: 32.2 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Commodore Component: machineset-egress-cidr-operator

This is a [Commodore][commodore] Component for machineset-egress-cidr-operator.

This repository is part of Project Syn.

For documentation on Project Syn and this component, see [syn.tools](https://syn.tools).

## Documentation

The rendered documentation for this component is available on the [Commodore Components Hub](https://hub.syn.tools/machineset-egress-cidr-operator).

Documentation for this component is written using [Asciidoc][asciidoc] and [Antora][antora].

It can be found in the [`docs`](docs) folder.

We use the [Divio documentation structure](https://documentation.divio.com/) to organize our documentation.

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://syn.tools/commodore/

[asciidoc]: https://asciidoctor.org/

[antora]: https://antora.org/