Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Not to forget to document #248

Open
7 tasks
chaen opened this issue Jun 4, 2024 · 0 comments
Open
7 tasks

Not to forget to document #248

chaen opened this issue Jun 4, 2024 · 0 comments

Comments

@chaen
Copy link
Contributor

chaen commented Jun 4, 2024

just a catch all list that I will increment as I go

Methodology
https://docs.divio.com/documentation-system/

  • All the settings and env variable that can influence diracx (pydantic 2 can embark some docs Extract attribute docstrings for FieldInfo.description pydantic/pydantic#6563)
  • 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
  • How datetimes are managed, and compatibility with DIRAC (timezone dependant, etc)
  • from __future__ import annotations mandatory

Testing

  • pytest.mark.enabled_dependencies
  • How we run tests (i.e. from which image, what is installed how (editable, from github etc)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant