https://github.com/appuio/component-grafana-organizations-operator

https://github.com/appuio/component-grafana-organizations-operator

commodore-component openshif4 openshift projectsyn syn

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/appuio/component-grafana-organizations-operator
• Owner: appuio
• License: bsd-3-clause
• Created: 2023-05-10T13:55:07.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-03-25T09:48:37.000Z (10 months ago)
• Last Synced: 2024-03-25T10:59:57.626Z (10 months ago)
• Topics: commodore-component, openshif4, openshift, projectsyn, syn
• Language: Makefile
• Homepage:
• Size: 24.4 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 2
• 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: grafana-organizations-operator

This is a [Commodore][commodore] Component for [grafana-organizations-operator](https://github.com/appuio/grafana-organizations-operator).

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/grafana-organizations-operator).

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

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

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