Comments (3)
Thanks for reporting this @nikolaik. Do you mean a verbatim copy of the output from
mount-s3 --help
with no further explanation? If that is the case, I'm not sure if it'll add value. TheCONFIGURATION.md
goes into more details that can be explained via the--help
option. It also has a narrative style tying everything together.
@arsh Thanks for the quick response. I meant a verbatim copy of the output from mount-s3 --help
or a concise list of options, description/behaviour and defaults. I think this is recognisable for people consuming CLIs in general, as it gives a quick overview of the available options with default values. It could help save some time for those familiarising themselves with the options available, without having to read too much prose. The benefit lies in knowing exactly which options are available, not having to worry if missing an option hidden in the extensive prose form docs.
from mountpoint-s3.
I like the idea of a short TL;DR at the top of that doc. Maybe beyond just showing the --help
output, we could also briefly call out some of the most common options folks are likely to want (--allow-delete
, --allow-overwrite
, --cache
, a couple others).
from mountpoint-s3.
Thanks for reporting this @nikolaik. Do you mean a verbatim copy of the output from mount-s3 --help
with no further explanation? If that is the case, I'm not sure if it'll add value. The CONFIGURATION.md
goes into more details that can be explained via the --help
option. It also has a narrative style tying everything together.
from mountpoint-s3.
Related Issues (20)
- Automatically create unique cache directories HOT 1
- Support providing `AES256` SSE type with each PutObject request HOT 1
- mount-s3 stopped working without explanation HOT 4
- Making the S3 filesystem available to the host from inside a docker container HOT 4
- Add --bind option to specify address when running on a host with multiple NICs HOT 2
- Error splicing file: File too large HOT 1
- `ls` fails every second run | `rewinddir` support HOT 11
- Operations hang indefinitely after opening too many files HOT 2
- Ability to configure maximum retry count
- Metadata Caching in case of not existing file HOT 12
- Full throughput limit is not being used HOT 7
- Need a function to monitoring the total usage of S3 mountpoint or S3 PVC HOT 1
- Slurm(srun) unable to start mountpoint HOT 11
- Support wasabi s3 storage HOT 1
- Support ovhcloud s3 high performance object storage HOT 1
- Support for writing to Google Cloud Storage buckets HOT 12
- I think there should be a cool icon for this product HOT 1
- ERROR awscrt::AuthCredentialsProvider: static: invalid credential_source property: EcsContainer HOT 4
- Assuming role configured in AWS profile does not work outside of `aws` partition (China, US Gov Cloud, etc.) HOT 5
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from mountpoint-s3.