docs: add some docs on how to find apis #873
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
phlogistonjohn
added
the
no-API
|
@Mergifyio rebase |
✅ Branch has been successfully rebased |
phlogistonjohn
force-pushed
the
jjm-finding-api-doc
branch
from
650d2c1
to
90220ac
Compare
|
@Mergifyio rebase |
✅ Branch has been successfully rebased |
phlogistonjohn
force-pushed
the
jjm-finding-api-doc
branch
from
90220ac
to
1c905da
Compare
anoopcs9
reviewed
May 16, 2023
phlogistonjohn
force-pushed
the
jjm-finding-api-doc
branch
from
1c905da
to
7511ebc
Compare
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>
phlogistonjohn
force-pushed
the
jjm-finding-api-doc
branch
from
7511ebc
to
c9c8075
Compare
anoopcs9
approved these changes
May 18, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Fixes: #872 (at least the call for improved docs part)
Checklist
n/a
New or infrequent contributors may want to review the go-ceph Developer's Guide including the section on how we track API Status and the API Stability Plan.
The go-ceph project uses mergify. View the mergify command guide for information on how to interact with mergify. Add a comment with
@Mergifyiorebaseto rebase your PR when github indicates that the PR is out of date with the base branch.