DIRACGrid · chaen · May 8, 2025 · May 8, 2025 · May 8, 2025
diff --git a/docs/admin/explanations/authentication.md b/docs/admin/explanations/authentication.md
@@ -0,0 +1,3 @@
+TODO
+
+- Security: various authentications (legacy exchange, oauth flows, pilots...), we need an external IDP, key rotations, etc -> authentication.md
diff --git a/docs/admin/explanations/opentelemetry.md b/docs/admin/explanations/opentelemetry.md
@@ -6,6 +6,6 @@
 `diracx.routers.otel.OTELSettings` classes
 `diracx` will then export metrics, traces, and logs. For the moment, nothing is really instrumented, but the infrastructure is there
 
-![OTEL Logs](./otel-logs.png)
-![OTEL Metrics](./otel-metrics.png)
-![OTEL Traces](./otel-traces.png)
+![OTEL Logs](https://diracx-docs-static.s3.cern.ch/assets/images/admin/explanations/otel/otel-logs.png)
+![OTEL Metrics](https://diracx-docs-static.s3.cern.ch/assets/images/admin/explanations/otel/otel-metrics.png)
+![OTEL Traces](https://diracx-docs-static.s3.cern.ch/assets/images/admin/explanations/otel/otel-traces.png)
diff --git a/docs/admin/explanations/user-management.md b/docs/admin/explanations/user-management.md
@@ -0,0 +1,4 @@
+TODO:
+synced from IdP, adminVO, VO Admin, groups, properties
+
+end with links to meaning of groups in DMS, WMS, etc
diff --git a/docs/dev/how-to/write-docs.md → ...min/reference/settings-and-preferences.md b/docs/dev/how-to/write-docs.md → ...min/reference/settings-and-preferences.md
diff --git a/docs/admin/tutorials/authentication.md b/docs/admin/tutorials/authentication.md
@@ -0,0 +1,5 @@
+TODO:
+
+decoding a token
+finding a token file
+meaning of properties, policies
diff --git a/docs/dev/explanations/designing-functionality.md b/docs/dev/explanations/designing-functionality.md
@@ -0,0 +1 @@
+(make all the ops bulk, point to the explanations)
diff --git a/docs/dev/explanations/extensions.md b/docs/dev/explanations/extensions.md
@@ -0,0 +1,5 @@
+# TODO
+
+How extensions works and what you need to consider when extending
+
+only one extension
diff --git a/docs/dev/explanations/testing.md b/docs/dev/explanations/testing.md
@@ -9,3 +9,5 @@ Note: `diracx-logic` does not contain any unit tests, developers are expected to
 For the integration tests, we always use the [services|tasks|client] dev image and do a pip install directly with `--no-deps`.
 
 Same for unit tests (router tests use `services:dev`, etc)
+
+Possibly: reference of all the fixtures we have
diff --git a/docs/dev/how-to/add-a-test.md b/docs/dev/how-to/add-a-test.md
@@ -0,0 +1,4 @@
+# TODO
+
+- Adding a test for a DB
+- Adding a test for a router with initial db content
diff --git a/docs/dev/how-to/extend-diracx/index.md b/docs/dev/how-to/extend-diracx/index.md
@@ -0,0 +1,3 @@
+TODO
+
+how to mechanically create the extension (reference to gubbins)
diff --git a/docs/dev/reference/application-state.md b/docs/dev/reference/application-state.md
@@ -0,0 +1,11 @@
+# TODO
+
+whatever is a singletin
+
+- engine context
+- config source
+- etc
+
+Dependency injection mechanism
+
+- dependency injections (in a service you do this, in a task you do this)
diff --git a/docs/dev/reference/client-metapathfinder.md b/docs/dev/reference/client-metapathfinder.md
diff --git a/docs/dev/reference/coding-conventions.md b/docs/dev/reference/coding-conventions.md
@@ -2,6 +2,8 @@
 
 TODO: update
 
+DO NOT FORGET TESTS
+
 Most style are enforced with the pre-commit hooks which automatically reformat the code and sort the imports.
 Code should follow PEP-8, particularly for [naming conventions](https://peps.python.org/pep-0008/#prescriptive-naming-conventions) as these aren't modified by the pre-commit hooks.
 

diff --git a/docs/dev/reference/db-transaction-model.md b/docs/dev/reference/db-transaction-model.md
diff --git a/docs/dev/reference/entrypoints.md b/docs/dev/reference/entrypoints.md
@@ -0,0 +1,3 @@
+#TODO
+
+list of entrypoints and what they are
diff --git a/docs/dev/reference/security-policies.md b/docs/dev/reference/security-policies.md
@@ -0,0 +1,3 @@
+# TODO
+
+uses the security-properties
diff --git a/docs/dev/reference/security-properties.md b/docs/dev/reference/security-properties.md
@@ -0,0 +1,3 @@
+# TODO
+
+auto generated dump of properties
diff --git a/docs/dev/tutorials/advanced-tutorial.md b/docs/dev/tutorials/advanced-tutorial.md
@@ -0,0 +1,8 @@
+# TODO
+
+Add a new system:
+add a new DB
+adding a router
+add settings
+add a policy
+add tasks
diff --git a/docs/dev/tutorials/getting-started.md b/docs/dev/tutorials/getting-started.md
@@ -1,4 +1,7 @@
 TODO
+
+refer to fast API
+
 GEtting a dev environment
 `run_local`
 `run pytest`

diff --git a/docs/dev/tutorials/play-with-auth.md → docs/dev/tutorials/making-changes.md b/docs/dev/tutorials/play-with-auth.md → docs/dev/tutorials/making-changes.md
@@ -1,4 +1,18 @@
+# TODO
+
+Modify an existing router
+
+follow the fast API
+
+add a new empty route hello world
+
+Add the auth
+
 ### User information
 
 The `user_info` object contains validation information about the current user, extracted from the authorization header of the request.
 See the `UserInfo` class for the available properties.
+
+Use the DB of the router
+
+something about Tasks
diff --git a/docs/dev/tutorials/write-docs.md b/docs/dev/tutorials/write-docs.md
@@ -0,0 +1,6 @@
+#TODO
+
+serve the documentation locally
+denovio doc
+mkdocs
+mkdocs plugin
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		TODO

		- Security: various authentications (legacy exchange, oauth flows, pilots...), we need an external IDP, key rotations, etc -> authentication.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		(make all the ops bulk, point to the explanations)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -9,3 +9,5 @@ Note: `diracx-logic` does not contain any unit tests, developers are expected to
		For the integration tests, we always use the [services\|tasks\|client] dev image and do a pip install directly with `--no-deps`.

		Same for unit tests (router tests use `services:dev`, etc)

		Possibly: reference of all the fixtures we have
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		TODO

		how to mechanically create the extension (reference to gubbins)