Skip to content
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

Site examples patch version #666

Merged

Conversation

sdowell
Copy link
Contributor

@sdowell sdowell commented Dec 6, 2021

Issue: kptdev/kpt#2609

This adds a new catalog-v2.json endpoint which expands upon the previous catalog.json schema to also include the latest patch version for each major/minor function release. This is presented as a new endpoint in order to avoid breaking compatibility with existing consumers of the original endpoint, such as versions of kpt already in the wild.

Updates the catalog pages of the website to include the latest patch version in:

  • The version dropdown for the function
  • A new dynamically rendered latest image section

@sdowell
Copy link
Contributor Author

sdowell commented Dec 7, 2021

Before clicking the dropdown:

image

After clicking the dropdown

image

@droot
Copy link
Contributor

droot commented Dec 8, 2021

I find that image URL to be really big and distracting. It also doesn't tell what that is. One possible presentation could be having a

Image: (with the dimensions shown below code section of github)

image

@droot
Copy link
Contributor

droot commented Dec 8, 2021

One more question: if you change the version in the drop down, do the image URL also get changed ?

I think we can also probably display it under the function heading:

apply-setters

Image URL: gcr.io/kpt-fn/apply-setters:v0.1.1

} else {
catalogPath = "/catalog.json";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we still serve catalog.json?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it's still served at the same path

This endpoint provides a new schema for the catalog.json file.
The motivation for this change is to provide access to the latest
patch version for each major/minor version for each function.
A new endpoint is added in order to avoid breaking backwards
compatibility with existing consumers of the catalog.json
endpoint, such as older versions of kpt already in the wild.

Issues: kptdev/kpt#2609
@droot
Copy link
Contributor

droot commented Dec 8, 2021

One more question: if you change the version in the drop down, do the image URL also get changed ?

I think we can also probably display it under the function heading:

apply-setters

Image URL: gcr.io/kpt-fn/apply-setters:v0.1.1

Closing the loop on this. We discussed offline and decided to add this as an incremental change. Scope of this PR is now reduced to just ensuring content in the catalog has latest patch version instead of the minor versions.

Consumes the new catalog-v2.json endpoint which provides the
latest patch versions. The latest patch version is now presented
in the version dropdown for the function.

Issues: kptdev/kpt#2609
Copy link
Contributor

@droot droot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will defer to @mengqiy to approve it.

@mengqiy mengqiy merged commit 07660de into GoogleContainerTools:master Dec 9, 2021
mengqiy pushed a commit that referenced this pull request Dec 10, 2021
mengqiy pushed a commit that referenced this pull request Dec 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants