https://github.com/projectsyn/component-floodgate
Commodore component for https://github.com/projectsyn/floodgate
https://github.com/projectsyn/component-floodgate
commodore-component suc system-upgrade-controller
Last synced: 3 months ago
JSON representation
Commodore component for https://github.com/projectsyn/floodgate
- Host: GitHub
- URL: https://github.com/projectsyn/component-floodgate
- Owner: projectsyn
- License: bsd-3-clause
- Created: 2022-03-17T08:44:02.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2025-01-07T15:25:00.000Z (4 months ago)
- Last Synced: 2025-01-07T16:21:29.025Z (4 months ago)
- Topics: commodore-component, suc, system-upgrade-controller
- Language: Makefile
- Homepage:
- Size: 47.9 KB
- Stars: 0
- Watchers: 7
- 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: floodgate
This is a [Commodore][commodore] Component for floodgate.
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/floodgate).
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/