docs update

[yangcao77]

Signed-off-by: Stephanie [email protected]

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:

[yangcao77]

@michael-valdron can you help add the starter project changes to those two docs as well? Thanks

[michael-valdron]

@michael-valdron can you help add the starter project changes to those two docs as well? Thanks

Done!

[kim-tsao]

@michael-valdron can you help add the starter project changes to those two docs as well? Thanks

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

[yangcao77]

@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?

[michael-valdron]

@michael-valdron can you help add the starter project changes to those two docs as well? Thanks

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

For Starter Projects I did not update the registry-library, @yangcao77 and I only updated the following:

• devfile/library - filters, bug fix
• index/generator - util functions
• index/server - endpoints, dependency updates

[yangcao77]

@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?

[elsony]

@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.

In general, our library API should minor the function of the REST API. So +1 on adding that as part of the library.

[kim-tsao]

@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.

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

[johnmcollier]

I won't pile on to the plus 1s 🙂 , but can we get an issue open for the registry library changes?

[kim-tsao]

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?

[kim-tsao]

Remove, Request Example subheading is not formatted properly

[yangcao77]

updated

[kim-tsao]

Remove, Request Example subheading is not formatted properly

[yangcao77]

updated

[yangcao77]

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?

Good point. I added a navigation table at top of the doc. Can you review it as well?

[kim-tsao]

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?

Good point. I added a navigation table at top of the doc. Can you review it as well?

yes, I'll review it

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: kim-tsao, yangcao77
To complete the pull request process, please assign maysunfaisal after the PR has been reviewed.
You can assign the PR to them by writing /assign @maysunfaisal in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[michael-valdron]

I won't pile on to the plus 1s slightly_smiling_face , but can we get an issue open for the registry library changes?

devfile/api#842

@johnmcollier @yangcao77 @kim-tsao @elsony