docs: secrets troubleshooting fixes + framework-version sweep (2.0 → 2.0+)#190
Conversation
- Replace the non-existent dj.config._config_sources line with a working snippet that uses find_config_file / find_secrets_dir from datajoint.settings to show which paths were resolved. - Reorder "Accidentally Committed Secrets" so credential rotation is the first concrete step — history rewrite is cleanup that doesn't un-leak the secret. Add a warning admonition spelling that out, and expand step 1 with the specific credential classes to rotate (database, object store, third-party tokens) and the access-log audit.
The docs cover the entire 2.x line, not the 2.0 release specifically.
Switch product-level references from "DataJoint 2.0" to "DataJoint 2.0+"
in README and the how-to / reference / tutorial pages that describe the
framework as it currently exists.
Historical statements ("introduced in 2.0", "What's New in 2.0", paper
citation "DataJoint 2.0: A Computational Substrate...", pre-2.0 vs 2.0
implementation comparisons) intentionally keep their literal version
references.
|
@MilagrosMarin when you have a moment, could you take a look? Two unrelated docs sweeps bundled here — the secrets-troubleshooting fixes (real diagnostic snippet + rotate-first incident order) and the framework-version sweep from "DataJoint 2.0" to "DataJoint 2.0+" in user-facing prose. The body lists what was intentionally left as historical (release-event pages, paper citations, etc.). No rush. |
MilagrosMarin
left a comment
There was a problem hiding this comment.
Both changes land cleanly: the find_config_file() / find_secrets_dir() diagnostic snippet works against the actual datajoint.settings API, and the rotate-first framing for accidental commits is the correct incident-response order. The 2.0 → 2.0+ sweep is consistent.
Tiny nudge, optional: src/reference/specs/autopopulate.md and src/how-to/use-plugin-codecs.md still have "DataJoint 2.0" references that weren't updated. Both fit the same "release-specific / historical" rationale that keeps type-system.md unchanged, so leaving them as-is is defensible — worth adding to the "intentionally left as-is" list in the PR body for completeness.
Approving.
|
Thanks @MilagrosMarin — good catch. I checked both and agree they're not product-level prose, so I've documented them in the "intentionally left as-is" list rather than sweeping:
Updated the PR body accordingly. |
Summary
Two unrelated docs sweeps, bundled per request.
1.
how-to/manage-secrets.md— troubleshooting fixesprint(dj.config._config_sources) # Not a real attribute, just conceptualline — copy-pasting it raises
AttributeError. Replaced with a workingsnippet using
find_config_file()/find_secrets_dir()fromdatajoint.settings, plus a note on whatNonemeans.first concrete step. History rewrite is cleanup — it does not un-leak a
secret that already reached a remote. Added a warning admonition and
expanded step 1 with the specific credential classes (database user,
object-store keys, third-party tokens) and an access-log audit.
2. Framework version: "DataJoint 2.0" → "DataJoint 2.0+"
The docs cover the entire 2.x line, not the 2.0 release specifically.
Updated product-level references in
README.mdand the how-to / reference /tutorial pages that describe the framework as it currently exists.
Touched:
README.md,src/how-to/installation.md,src/how-to/deploy-production.md,src/how-to/migrate-to-v20.md,src/reference/specs/fetch-api.md,src/reference/specs/object-store-configuration.md,src/tutorials/basics/04-queries.ipynb.Intentionally left as-is (historical / release-specific):
whats-new-2.md,whats-new-21.md,whats-new-22.md(release-event pages)versioning.mdbaseline referencescitation.md/publications.mdtype-system.mdjob-metadata.mduse-cli.mdautopopulate.md— "DataJoint 2.0 replaces the schema-level~jobstable"describes the 2.0 release event (same rationale as
job-metadata.md)use-plugin-codecs.md— literal version pins (datajoint>=2.0.0) andplugin codec-versioning examples (
2.0 → 3.0,codec_version = "2.0");illustrative/literal, not product-level prose
Test plan
mkdocs serve— both troubleshooting subsections + version-touched pages render cleanlylycheepasses locally (431 OK / 0 errors)