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.

Sign up for GitHub

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

Jump to bottom

Adding note for experimental and hidden flags #2571

Closed
wants to merge 4 commits into from
Closed

Adding note for experimental and hidden flags #2571

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
08351ae
Adding note for experimental or private flag
raj-prince Oct 10, 2024
64e87f8
minor comment change
raj-prince Oct 10, 2024
99c2bad
review comments
raj-prince Oct 10, 2024
86a3165
Update README.md
raj-prince Oct 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ To learn about limitations and differences between Cloud Storage FUSE and POSIX

For information about pricing for Cloud Storage FUSE, see https://cloud.google.com/storage/docs/gcs-fuse#charges.

## Agreement on Flag Compatibility
Copy link
Collaborator

Choose a reason for hiding this comment

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

I dont think we should put this in the main readme page. Its not that important imo to be put it in first page. This will be visible in the repo page as soon as someone wants to use fuse.
Can we add it in the usage or any other readme file.

`Experimental` and `hidden` flags are subject to changed/removed even across minor releases and have no SLA.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Also, users dont even know about hidden flags. It seems unnecessary to mention here.
Experimental seems like a note we could add in the flags page or in the dev guide.


# CSI Driver

Using the [Cloud Storage FUSE CSI driver](https://github.com/GoogleCloudPlatform/gcs-fuse-csi-driver), users get the declarative nature of Kubernetes
Expand All @@ -46,4 +49,3 @@ To see supported operating system and ML frameworks that have been validated wit
You can get support, submit general questions, and request new features by [filing issues in GitHub](https://github.com/GoogleCloudPlatform/gcsfuse/issues). You can also get support by using one of [Google Cloud's official support channels](https://cloud.google.com/support-hub).

See [Troubleshooting](https://github.com/GoogleCloudPlatform/gcsfuse/blob/master/docs/troubleshooting.md) for common issue handling.

Loading