docs: secrets troubleshooting fixes + framework-version sweep (2.0 → 2.0+)#190
Open
dimitri-yatsenko wants to merge 2 commits into
Open
docs: secrets troubleshooting fixes + framework-version sweep (2.0 → 2.0+)#190dimitri-yatsenko wants to merge 2 commits into
dimitri-yatsenko wants to merge 2 commits into
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.
dimitri-yatsenko
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdTest plan
mkdocs serve— both troubleshooting subsections + version-touched pages render cleanlylycheepasses locally (431 OK / 0 errors)