Skip to content

Commit b0dfc2e

Browse files
chaenchaen
committed
Split developer documentation
1 parent ecdaf86 commit b0dfc2e

26 files changed

+141
-147
lines changed

‎docs/DEVELOPERS.md‎

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎docs/README.md‎

Lines changed: 0 additions & 135 deletions
This file was deleted.

docs/admin/how-to/convert_cs.md renamed to docs/admin/how-to/convert-cs.md

File renamed without changes.

docs/admin/how-to/register_a_vo.md renamed to docs/admin/how-to/register-a-vo.md

File renamed without changes.

docs/admin/how-to/register_the_admin_vo.md renamed to docs/admin/how-to/register-the-admin-vo.md

File renamed without changes.

security_model.md renamed to docs/admin/reference/security_model.md

File renamed without changes.

docs/dev/explanations/packaging/api.md renamed to docs/dev/explanations/components/api.md

File renamed without changes.

docs/dev/explanations/packaging/cli.md renamed to docs/dev/explanations/components/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ TODO: WRONG
4949
- To associate the command with `dirac`, import the module in `src/diracx/__init__.py`:
5050

5151
```python
52-
from . import command
52+
from . import command
5353
...
5454

5555
app.add_typer(<command name>.app, name="<command name>")

docs/DATABASES.md renamed to docs/dev/explanations/components/db.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Databases
22

3+
TODO: review
4+
35
The primary store of operational data in DiracX is in SQL databases managed through SQLAlchemy.
46
In addition, DiracX utilizes OpenSearch (or Elasticsearch) for storing pilot logs, medium-term metadata about jobs and pilots ("Job Parameters" and "Pilot Parameters"), and optionally, for OpenTelemetry data.
57
Access to databases is managed by the `diracx-db` package.

docs/VERSIONING.md renamed to docs/dev/explanations/components/index.md

File renamed without changes.

0 commit comments

Comments
 (0)