doc: document the supported URLs #58
Conversation
imobachgs
force-pushed
the
document-urls
branch
from
7f506bb to
1f5fcd4
Compare
kobliha
left a comment
kobliha
left a comment
There was a problem hiding this comment.
I've added a few nitpicking comments, nothing serious. The document is good, informative and well-written in general.
docs/user/urls.md
Outdated
| In addition to those schemes, Agama supports a set of specific ones which can be | ||
| rather useful: | ||
|
|
||
| - [`device`](#device) for finding files in specific devices (even unmounted |
There was a problem hiding this comment.
There is an interesting discussion whether something is "in the device" or "on the device" https://english.stackexchange.com/questions/326475/on-hard-drive-versus-in-memory
My brain still sees that "on the device", although SSDs don't have any platters anymore and thus it would logically be "in the device" instead, but historically it's "on". This is a computer-speak, "in" is a correct English way :D
There was a problem hiding this comment.
I will check with the documentation team.
There was a problem hiding this comment.
I am following up on your suggestion after checking with the docu team, although both options are correct. Actually, we have an interesting thread in Slack talking about that 😉
docs/user/urls.md
Outdated
| supported by Agama. | ||
|
|
||
| [^2]: | ||
| Use `smb` instead of `cifs`, although in the future you should be able to |
There was a problem hiding this comment.
So the SMB is actually not documented and there is no reference how the URI should look like?
There was a problem hiding this comment.
I would say it is not specific to YaST/Agama, and that's the reason I decided not to document them. Otherwise, I would need to document all supported URLs. If that's what we want, I would create a separate PBI for that.
There was a problem hiding this comment.
Yep I know, but cifs and nfs are not usually known kinds of URI. I would simply link to some other page, e.g., https://datatracker.ietf.org/doc/rfc2224/ for NFS it's also quite interesting https://lists.samba.org/archive/samba-technical/2001-April/013007.html and hierynomus/smbj#89
Anyway, not a big deal. I simply like to have a bit more complete info when I'm searching for some info so I don't need to ask AI for the solution :D
docs/user/urls.md
Outdated
|
|
||
| [^1]: | ||
| Agama relies on [curl](https://curl.se/) to support generic protocols | ||
| (network protocols and `file://`). So it might happen that some protocol is |
There was a problem hiding this comment.
I would probably still give a few examples, especially the file:// is not well-known.
There was a problem hiding this comment.
file:// and smb:// are sort of standards, so I decided to focus on our specific ones.
2 participants
Add documentation for YaST-like URLs. You can check the rendered version for easier reviewing.