Skip to content

Mkdocs#1

Merged
guzman-raphael merged 6 commits into
datajoint:mainfrom
A-Baji:mkdocs
Sep 17, 2022
Merged

Mkdocs#1
guzman-raphael merged 6 commits into
datajoint:mainfrom
A-Baji:mkdocs

Conversation

@A-Baji

@A-Baji A-Baji commented Aug 25, 2022

Copy link
Copy Markdown
Contributor

To automate:

  • init/update git submodules
  • build parent search index
  • rebuild docs on child update

@guzman-raphael guzman-raphael marked this pull request as ready for review September 17, 2022 16:37

@guzman-raphael guzman-raphael left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @A-Baji! 💪

Since you've been busy with other projects lately, I can help out and pick this up where you left off. I'll merge what is here for now and reach back if I have any questions.

@guzman-raphael guzman-raphael merged commit 4da235f into datajoint:main Sep 17, 2022
guzman-raphael pushed a commit that referenced this pull request May 12, 2023
@A-Baji A-Baji deleted the mkdocs branch June 7, 2023 15:57
guzman-raphael pushed a commit that referenced this pull request Jun 8, 2023
dimitri-yatsenko pushed a commit that referenced this pull request Apr 15, 2025
dimitri-yatsenko added a commit that referenced this pull request Jan 14, 2026
…erminology

Fixed terminology inconsistency identified in cohesion review:
- TERMINOLOGY.md explicitly deprecates 'inline storage' → 'in-table'
- Updated all documentation to use canonical terminology

Files changed:
- how-to/use-object-storage.md: inline → in-table (3 occurrences)
- reference/specs/type-system.md: inline → in-table (3 occurrences)
- reference/specs/codec-api.md: inline → in-table (2 occurrences)
- reference/specs/npy-codec.md: inline → in-table (1 occurrence)
- explanation/whats-new-2.md: inline attachment → in-table attachment
- llms-full.txt: regenerated to pick up all fixes

Verified: No deprecated inline storage terminology remains in markdown files.

Fixes: COHESION-REVIEW.md Issue #1 (High Priority)
dimitri-yatsenko added a commit that referenced this pull request Jun 5, 2026
Fixes for items #2 and #4 from her review:

- storage-adapter-api.md: removed the "Built-in adapters" section and the
  claim that file/s3/gcs/azure protocols are themselves StorageAdapter
  subclasses. In v2.2.3 those protocols are still served by the existing
  StorageBackend._create_filesystem() dispatch; migrating them onto the
  public adapter contract is tracked separately.
- storage-adapter-api.md: added an "Available in datajoint ≥ 2.2.4" note
  near the StorageAdapter base-class introduction. dj.StorageAdapter /
  dj.get_storage_adapter() are not exported in 2.2.3; a paired
  datajoint-python PR adds the exports for 2.2.4.
- whats-new-2-2-3.md: reframed the "Storage-adapter plugin contract"
  section to match — the contract is for third-party adapters; built-ins
  continue via internal dispatch.
- manage-secrets.md: corrected the lone remaining DJ_TLS=true → DJ_USE_TLS=true
  in the env-var example (line 88).

Items #3 (settings.py "New in 2.3" markers) and #1 (StorageAdapter export)
are addressed by separate datajoint-python PRs.
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

Successfully merging this pull request may close these issues.

2 participants