Adding note for experimental and hidden flags #2571
Conversation
kislaykishore
requested review from
a team and
BrennaEpp
and removed request for
a team
docs/dev_guide.md
Outdated
| @@ -31,3 +31,5 @@ new param available in both the modes: | |||
| [root_test.go](https://github.com/GoogleCloudPlatform/gcsfuse/blob/master/cmd/root_test.go) | |||
| 1. Add the name of flag with underscores in | |||
| [mount_gcsfuse/main.go](https://github.com/GoogleCloudPlatform/gcsfuse/blob/master/tools/mount_gcsfuse/main.go) | |||
|
|
|||
| > NOTE: Flags marked as `experimental` or private are subject to change at any time and should be used with caution. | |||
There was a problem hiding this comment.
I think this should be part of user guide instead of dev guide. On a side note, I am working on a PR to create dev guidelines: master...coding_guidelines#diff-4c6b93aa75d5affde60dc3849606c9acd75ed444d52e99f3055fc0c7aa77e9e0R16 where I have mentioned this.
There was a problem hiding this comment.
Discussed offline, adding note on hidden flags doesn't make sense in cloud-user-doc. Hence, moving it to readme doc.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2571 +/- ##
==========================================
+ Coverage 78.20% 78.28% +0.07%
==========================================
Files 107 107
Lines 11802 11802
==========================================
+ Hits 9230 9239 +9
+ Misses 2081 2071 -10
- Partials 491 492 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
kislaykishore
changed the title
Co-authored-by: Kislay Kishore <[email protected]>
| @@ -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 | |||
There was a problem hiding this comment.
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.
| @@ -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 | |||
| `Experimental` and `hidden` flags are subject to changed/removed even across minor releases and have no SLA. | |||
There was a problem hiding this comment.
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.
|
Closing it. Offline discussed with @charith87 |
Description
Added Note: Flags marked as experimental or hidden are subject to change at any time and should be used with caution.
Link to the issue in case of a bug fix.
NA
Testing details