From 0dd16d658fcc64d270e0aa360400b26b52bfb866 Mon Sep 17 00:00:00 2001 From: Daniel <d.hornung@indiscale.com> Date: Fri, 1 Sep 2023 12:54:09 +0200 Subject: [PATCH] DOC: Better documentation hints in MR template. --- .gitlab/merge_request_templates/Default.md | 4 +++- README_SETUP.md | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.gitlab/merge_request_templates/Default.md b/.gitlab/merge_request_templates/Default.md index 35c6d01..3629e0c 100644 --- a/.gitlab/merge_request_templates/Default.md +++ b/.gitlab/merge_request_templates/Default.md @@ -28,6 +28,7 @@ guidelines](https://gitlab.com/caosdb/caosdb/-/blob/dev/REVIEW_GUIDELINES.md) - [ ] Up-to-date CHANGELOG.md (or not necessary) - [ ] Up-to-date JSON schema (or not necessary) - [ ] Appropriate user and developer documentation (or not necessary) + - Update / write published documentation (`make doc`). - How do I use the software? Assume "stupid" users. - How do I develop or debug the software? Assume novice developers. - [ ] Annotations in code (Gitlab comments) @@ -41,7 +42,8 @@ guidelines](https://gitlab.com/caosdb/caosdb/-/blob/dev/REVIEW_GUIDELINES.md) - [ ] I understand the intent of this MR - [ ] All automated tests pass - [ ] Up-to-date CHANGELOG.md (or not necessary) -- [ ] Appropriate user and developer documentation (or not necessary) +- [ ] Appropriate user and developer documentation (or not necessary), also in published + documentation. - [ ] The test environment setup works and the intended behavior is reproducible in the test environment - [ ] In-code documentation and comments are up-to-date. diff --git a/README_SETUP.md b/README_SETUP.md index 3e483c6..935a693 100644 --- a/README_SETUP.md +++ b/README_SETUP.md @@ -4,7 +4,7 @@ This package requires the following software: -- conan: `pip install conan` +- conan: `pip install "conan<2"` - libcaosdb: Download the [libcaosdb sources](https://gitlab.com/caosdb/caosdb-cpplib) and run `make conan`. See https://gitlab.indiscale.com/caosdb/src/caosdb-cpplib for further instructions. - For running this library, a valid libcaosdb configuration is needed, for example a -- GitLab