Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Improve virtual ref docs #284

Merged
merged 3 commits into from
Oct 16, 2024
Merged

[Docs] Improve virtual ref docs #284

merged 3 commits into from
Oct 16, 2024

Conversation

mpiannucci
Copy link
Contributor

@mpiannucci mpiannucci commented Oct 16, 2024

@mpiannucci mpiannucci changed the title Improve virtual ref docs [Docs] Improve virtual ref docs Oct 16, 2024
@mpiannucci mpiannucci requested a review from paraseba October 16, 2024 13:21
Comment on lines 20 to 21
- S3 Compatible - References to files accessible via S3 compatible storage. For more information on configuring credentials for virtual references on s3 see [the configuration docs](./configuration.md#virtual-reference-storage-config).
- Filesystem - References to files accessible via local filesystem. This requires any file paths to be **absolute** at this time.
Copy link
Contributor

Choose a reason for hiding this comment

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

Give examples of the exact format for each type of ref.

@mpiannucci mpiannucci merged commit d124bed into main Oct 16, 2024
2 checks passed
@mpiannucci mpiannucci deleted the matt/virtual-docs-impv branch October 16, 2024 14:02
dcherian added a commit that referenced this pull request Oct 21, 2024
* main: (167 commits)
  Bump actions/checkout from 2 to 4 in the actions group (#305)
  update zarr pin to v3.0.0b1 (#302)
  Fix non-conformant "attributes" metadata (#303)
  Implement branch reset functionality (#301)
  README minor tune up: syntax and other very minor typos etc (#300)
  remove awaits in icechunk notebook (#298)
  Add missing permission to release action (#295)
  Minor changes to virtual docs (#293)
  Add changelogs (#291)
  Install cargo release (#290)
  Update python ci (#289)
  GHA workflow to release Rust (#288)
  Release 0.1.0-alpha.3 to the Rust world (#287)
  `ByteRange` can do last n bytes now (#285)
  Introduce `Store::list_dir_items` (#286)
  [Docs] Improve virtual ref docs (#284)
  [Docs] correct output dimensions in xr example (#283)
  [Docs] add note for requirements of tutorial data download (#282)
  [Docs] correct module calls to match imports (#281)
  fix(docs): Docs postlaunch fixes (#278)
  ...
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