From e4670377e109fa5f5172c64639cb0462c7dbc59b Mon Sep 17 00:00:00 2001 From: Nacho Barrientos <nacho.barrientos@cern.ch> Date: Mon, 17 Mar 2025 12:01:15 +0100 Subject: [PATCH] Align documentation section to reality --- README.md | 8 +++++--- README.md.gotmpl | 8 +++++--- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d861979..d1f2e0f 100644 --- a/README.md +++ b/README.md @@ -162,10 +162,12 @@ For a full contribution workflow, visit the [contribution guide](CONTRIBUTING.md ## Documentation -Complete documentation for this chart, including setup and configuration details, is available: +The main source of documentation for this chart is this +README. There's some extra details about the components being deployed +in the [docs](docs) directory, though. -- GitLab Repository: [link](docs) -- Project Documentation: [link](https://monit-docs.web.cern.ch) +The [MONIT project documentation](https://monit-docs.web.cern.ch) +contains useful bits complementing this chart. ## License diff --git a/README.md.gotmpl b/README.md.gotmpl index 46dbbee..065dc65 100644 --- a/README.md.gotmpl +++ b/README.md.gotmpl @@ -33,10 +33,12 @@ For a full contribution workflow, visit the [contribution guide](CONTRIBUTING.md ## Documentation -Complete documentation for this chart, including setup and configuration details, is available: +The main source of documentation for this chart is this +README. There's some extra details about the components being deployed +in the [docs](docs) directory, though. -- GitLab Repository: [link](docs) -- Project Documentation: [link](https://monit-docs.web.cern.ch) +The [MONIT project documentation](https://monit-docs.web.cern.ch) +contains useful bits complementing this chart. ## License -- GitLab