Commit Graph

4 Commits

Author SHA1 Message Date
John Mulligan 66fe3724d2 docs: add some docs on how to find apis
Add some prose to the hints doc on how to use our docs convention to
map a C/command line api to a go-ceph api.
Note how to make use of a {Mon,Mgr}Command API JSON-command without
go-ceph code.
Note how apis start as preview before becoming stable.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2023-05-18 13:56:22 +00:00
John Mulligan 94489bef9d docs: fix an existing spelling mistake
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2022-09-07 16:11:29 +00:00
John Mulligan 2d32182694 docs: add official documentation for how go-ceph does errors
Based on https://github.com/ceph/go-ceph/discussions/557

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2022-09-07 16:11:29 +00:00
John Mulligan 4ec7a91da8 readme: move the scattershot api hints to a separate doc
There were various random "documentation" tidbits, all for rados,
on the main readme. As these are neither comprehensive nor complete
I am moving them to a seperate page and calling them "hints" which
seem to be closer to what they are.

Eventually, we could include more comprehensive examples in the
docs/ directory.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-08-28 13:44:24 -04:00