-
Notifications
You must be signed in to change notification settings - Fork 27
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs update #113
docs update #113
Conversation
…s repo Signed-off-by: Stephanie <yangcao@redhat.com>
@michael-valdron can you help add the starter project changes to those two docs as well? Thanks |
Signed-off-by: Stephanie <yangcao@redhat.com>
Done! |
@michael-valdron can you also update this doc? https://github.com/devfile/registry-support/blob/main/registry-library/README.md It's the documentation for the registry library API |
@kim-tsao Micheal did not update the registry library, so no need to update that doc. but perhaps an API should be introduced to the library for starterprojects @michael-valdron @johnmcollier Any thoughts? |
For Starter Projects I did not update the registry-library, @yangcao77 and I only updated the following:
|
Signed-off-by: Michael Valdron <mvaldron@redhat.com>
a7e78b2
to
aab99c2
Compare
@michael-valdron since registry library is just providing library API to interact with registry server, it should reflect all features that REST APIs provide. I do think we need to include the starterproject APIs in registry library. So tools like odo can start consuming the registry library APi, instead of creating their own. @kim-tsao @johnmcollier @elsony what do you guys think? |
In general, our library API should minor the function of the REST API. So +1 on adding that as part of the library. |
I agree |
I won't pile on to the plus 1s 🙂 , but can we get an issue open for the registry library changes? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In general, the doc is pretty good but should we consider truncating some of the lengthier responses? Should we also have a table of contents so that users can directly navigate to the API they want?
index/server/registry-REST-API.adoc
Outdated
|
||
=== Request body | ||
The request body must be empty. | ||
= |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove, Request Example
subheading is not formatted properly
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated
index/server/registry-REST-API.adoc
Outdated
|
||
=== Request body | ||
The request body must be empty. | ||
= |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove, Request Example
subheading is not formatted properly
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated
Signed-off-by: Stephanie <yangcao@redhat.com>
Good point. I added a navigation table at top of the doc. Can you review it as well? |
yes, I'll review it |
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: kim-tsao, yangcao77 The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Signed-off-by: Stephanie yangcao@redhat.com
Please specify the area for this PR
registry-library doc
registry server doc
What does does this PR do / why we need it:
This PR updates the registry library doc with v2index changes.
also move the registry server REST API change to this repo, the landing page should point to this link afterwards
Which issue(s) this PR fixes:
devfile/api#838
PR acceptance criteria:
Test (WIP)
Documentation (WIP)
How to test changes / Special notes to the reviewer: