From dd20ebd041fcc591ef3720a67368c9c2cd03b7d3 Mon Sep 17 00:00:00 2001 From: simu Date: Thu, 11 Jan 2024 14:56:12 +0000 Subject: [PATCH] Update from template Template version: main (7803d07) --- .cruft.json | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 4 ++-- README.md | 8 ++++---- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.cruft.json b/.cruft.json index 13eb089..8c2f3c7 100644 --- a/.cruft.json +++ b/.cruft.json @@ -1,6 +1,6 @@ { "template": "https://github.com/projectsyn/commodore-component-template.git", - "commit": "8a2e7800ac2d62a4827968ce108f4d7b9bfd587f", + "commit": "7803d07f1d79fc8b902fcafbb336b6b0a4b57b90", "checkout": "main", "context": { "cookiecutter": { diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e2119f0..b8eaf6a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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. @@ -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. --> diff --git a/README.md b/README.md index ad2cdb4..a2914da 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,15 @@ This is a [Commodore][commodore] Component for vcluster. 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/vcluster). 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. @@ -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/