Feature #21504
closed
arv-mount reference page
Description
For as much as our users use it, arv-mount is underdocumented. Basically the only resource dedicated to it is the tutorial page about it. Explaining a lot of the more advanced features and options there would be premature, because this first section of the tutorial is about data management, so details of the Arvados API haven't been introduced yet.
Write a new reference-level page with details about arv-mount options. It should cover every arv-mount option in a table, with details about the expected format, how the value is interpreted, and the default (if any). Try to group related options together, like "what gets mounted" options, cache options, log options, etc. Take inspiration from our API reference.
Where should this page live?
- One option is to add it to a new "Reference" section at the end of the user guide. Long-term we could probably split out a whole "User Reference" supersection out of the user guide, but until we have enough pages to justify that, this is a reasonable starting point.
- Another option would be to create a section for arv-mount under the SDK section. The obvious downside of this is arv-mount isn't really an SDK, so that's weird. But this section already has other reference material interesting to users (like the Python and CLI SDK references) so it keeps like pages together.
Neither of these options are perfect, but they're both decent short-term solutions without doing damage to the current documentation organization.
Related issues
Updated by 
Updated by 
Updated by