Not to forget to document
- Dominant language
- Python
- Stars
- 19
- Forks
- 45
- Avg merge
- 4d 23h
- Merged PRs (30d)
- 12
Description
just a catch all list that I will increment as I go
Methodology
https://docs.divio.com/documentation-system/
https://github.com/jdoiro3/mkdocs-multirepo-plugin
* [x] All the settings and env variable that can influence `diracx` (pydantic 2 can embark some docs https://github.com/pydantic/pydantic/pull/6563) see https://github.com/DIRACGrid/diracx/issues/695
* [ ] How we want to handle time (i.e. DB operation rather than python)
* [ ] When adding a DB, don't forget to add it to the diracx-chart values tpl
* [x] How datetimes are managed, and compatibility with DIRAC (timezone dependant, etc)
* [x] `from __future__ import annotations` mandatory
## Testing
* [ ] `pytest.mark.enabled_dependencies`
* [x] How we run tests (i.e. from which image, what is installed how (editable, from github etc)
## TO VERIFY
- admin
- explanations
- [x] ./admin/explanations/configuration.md
- [x] ./admin/explanations/opentelemetry.md
- how-to
- [x] ./admin/how-to/convert-cs.md
- [x] ./admin/how-to/register-a-vo.md
- [x] ./admin/how-to/register-the-admin-vo.md
- reference
- [x] ./admin/reference/security_model.md
- dev
- explanations
- [x] ./dev/explanations/client.md
- [x] ./dev/explanations/index.md
- [x] ./dev/explanations/components/api.md
- [x] ./dev/explanations/components/cli.md
- [x] ./dev/explanations/components/db.md
- [x] ./dev/explanations/components/routes.md
- [x] ./dev/explanations/components/index.md
- [x] ./dev/explanations/testing.md
- how-to
- [ ] ./dev/how-to/client-customization.md
- [ ] ./dev/how-to/client-generation.md
- [ ] ./dev/how-to/add-a-db.md
- [ ] ./dev/how-to/add-a-setting.md
- [ ] ./dev/how-to/add-a-route.md
- [ ] ./dev/how-to/write-docs.md
- reference
- [ ] ./dev/reference/coding-conventions.md
- [ ] ./dev/reference/dependency-injection.md
- [ ] ./dev/reference/configuration.md
- tutorials
- [ ] ./dev/tutorials/getting-started.md
- [ ] ./dev/tutorials/run-locally.md
- [ ] ./dev/tutorials/play-with-auth.md
- user
- reference
- [ ] ./user/reference/client-configuration.md
- [x] ./index.md
- [x] ./project/consortium.md
- [x] ./project/index.md
- [x] ./roadmap.md
- [x] ./SECURITY.md
Contributor guide
Assessment
This issue has not been assessed yet.