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: Updated filesystem docs with explanations for bucket URLs #1435

Merged
merged 3 commits into from
Jun 10, 2024

Conversation

dat-a-man
Copy link
Collaborator

Description

Updated "verified-source/filesystem" docs for "bucket-url" explanation.

+ used fix_grammar_gpt.py

@dat-a-man dat-a-man requested a review from VioletM June 3, 2024 05:19
Copy link

netlify bot commented Jun 3, 2024

Deploy Preview for dlt-hub-docs ready!

Name Link
🔨 Latest commit 9d07097
🔍 Latest deploy log https://app.netlify.com/sites/dlt-hub-docs/deploys/66640e247be51c0008b7e7e4
😎 Deploy Preview https://deploy-preview-1435--dlt-hub-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@dat-a-man dat-a-man linked an issue Jun 3, 2024 that may be closed by this pull request
@dat-a-man dat-a-man added the documentation Improvements or additions to documentation label Jun 3, 2024
@dat-a-man dat-a-man changed the title Updated source/filesystem docs with explanations for bucket URLs Docs/ Updated filesystem docs with explanations for bucket URLs Jun 3, 2024
@dat-a-man dat-a-man changed the title Docs/ Updated filesystem docs with explanations for bucket URLs Docs: Updated filesystem docs with explanations for bucket URLs Jun 3, 2024
zem360
zem360 previously approved these changes Jun 5, 2024

1. You can pass the bucket URL and glob pattern or use `config.toml`. For local filesystems, use
3. You can pass the bucket URL and glob pattern or use `config.toml`. For local filesystems, use
`file://` or skip the schema and provide the local path in a format native for your operating system.
Copy link
Contributor

Choose a reason for hiding this comment

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

Just make this a bit more clear. I understand that for local filesystem, I have to use file:// or the code shown below would also work. Just make it a bit more clear.

Copy link
Contributor

Choose a reason for hiding this comment

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

I would say you can use file:// as follows:

  • code example

or
Define it as follows:

[sources.filesystem] # use [sources.readers.credentials] for the "readers" source
bucket_url='~\Documents\csv_files\'
file_glob="*"

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

updated as per comments

Copy link
Contributor

@zem360 zem360 left a comment

Choose a reason for hiding this comment

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

There is just one small change. The rest looks good

@zem360 zem360 merged commit 3609757 into devel Jun 10, 2024
41 checks passed
@zem360 zem360 deleted the docs/issue-1434-bucket-url-explanation-in-filesystem branch June 10, 2024 07:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add explanation what is bucket url for different filesystem types
2 participants