https://github.com/vshn/component-stackgres-operator
https://github.com/vshn/component-stackgres-operator
commodore-component vshn-project-ignore
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/vshn/component-stackgres-operator
- Owner: vshn
- License: bsd-3-clause
- Created: 2022-12-22T12:11:41.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-27T17:46:25.000Z (10 months ago)
- Last Synced: 2025-01-29T01:46:07.738Z (4 months ago)
- Topics: commodore-component, vshn-project-ignore
- Language: Makefile
- Homepage:
- Size: 376 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: stackgres-operator
This is a [Commodore][commodore] Component for stackgres-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/stackgres-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/