Skip to content

Commit

Permalink
Update from template
Browse files Browse the repository at this point in the history
Template version: main (a4aff6a)
  • Loading branch information
HappyTetrahedron committed Nov 22, 2023
1 parent 29618e4 commit 6a9a982
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .cruft.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"template": "https://github.com/projectsyn/commodore-component-template.git",
"commit": "8a2e7800ac2d62a4827968ce108f4d7b9bfd587f",
"commit": "a4aff6a9d004c1aad085a875c7759c8f8f1e0d3d",
"checkout": "main",
"context": {
"cookiecutter": {
Expand Down
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

## Checklist

- [ ] The PR has a meaningful title. It will be used to auto generate the
- [ ] The PR has a meaningful title. It will be used to auto-generate the
changelog.
The PR has a meaningful description that sums up the change. It will be
linked in the changelog.
Expand All @@ -21,6 +21,6 @@ review the checklist.
Contributors guide: ./CONTRIBUTING.md
Remove items that do not apply. For completed items, change [ ] to [x].
These things are not required to open a PR and can be done afterwards,
These things are not required to open a PR and can be done afterwards
while the PR is open.
-->
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
This is a [Commodore][commodore] Component for backup-k8up.

This repository is part of Project Syn.
For documentation on Project Syn and this component, see https://syn.tools.
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/backup-k8up).

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.
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.

Expand All @@ -20,7 +20,7 @@ After writing the documentation, please use the `make docs-vale` command and cor
## Contributing and license

This library is licensed under [BSD-3-Clause](LICENSE).
For information about how to contribute see [CONTRIBUTING](CONTRIBUTING.md).
For information about how to contribute, see [CONTRIBUTING](CONTRIBUTING.md).

[commodore]: https://syn.tools/commodore/
[asciidoc]: https://asciidoctor.org/
Expand Down

0 comments on commit 6a9a982

Please sign in to comment.