-
Notifications
You must be signed in to change notification settings - Fork 105
[WIP] Add docs for Chainguard Libraries on console UI #2373
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
Open
mosabua
wants to merge
1
commit into
chainguard-dev:main
Choose a base branch
from
mosabua:browse
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| --- | ||
| title: "Browsing Chainguard Libraries" | ||
| linktitle: "Browsing" | ||
| description: "Searching, browsing, and inspecting Chainguard Libraries in the console" | ||
| type: "article" | ||
| date: 2025-07-03T14:00:00+00:00 | ||
| lastmod: 2025-07-03T14:00:00+00:00 | ||
| draft: false | ||
| tags: ["Chainguard Libraries"] | ||
| menu: | ||
| docs: | ||
| parent: "libraries" | ||
| weight: 007 | ||
| toc: true | ||
| --- | ||
|
|
||
| Chainguard Libraries includes thousands of libraries and many more individual | ||
| library versions and artifacts. The Chainguard console includes features to | ||
| browse all available libraries and their versions, and inspect some of their | ||
| characteristics, before using them in your application development. | ||
|
|
||
| ## Access | ||
|
|
||
| Use your authentication details to access the console at | ||
| [https://console.chainguard.dev/](https://console.chainguard.dev/). | ||
|
|
||
| The left-hand navigation includes a **Libraries** section. Nested within the | ||
| **Ecosystems** drop-down you find links to browse the libraries from Chainguard | ||
| Libraries for **Java** and Chainguard Libraries for **Python**. | ||
|
|
||
| <a id="initial-display"></a> | ||
|
|
||
| ## Initial Display | ||
|
|
||
| The initial display when accessing a specific ecosystem shows a search input box | ||
| and a list of libraries with the following columns. | ||
|
|
||
| * **Name** - the full name of the library excluding any version identifiers. | ||
| Python library names are a simple string, such as `setuptools` or | ||
| `Flask-Admin`. Java library names are the concatenation of the Maven | ||
| coordinate values `groupId` and `artifactId`, separated by `:`. Examples are | ||
| `org.springframework:spring-core` or `org.eclipse.jetty:jetty-http`. | ||
| * **Latest version** - the latest released and available version of the library | ||
| and the total number of available versions. | ||
| * **Created** - TBD .. not sure what specific date that is, arguably it should | ||
| be removed because it is not clear what library version these values are for, | ||
| or header tile should change to Latest version release date or something | ||
| (upstream release date ...), when Chainguard built a library could be a | ||
| separate field but that might be less useful, | ||
| * **Updated** - TBD .. not sure .... I think we should remove this, libraries | ||
| should not change so there should be no updated date | ||
|
|
||
| Below the list is a pagination control with **Previous** and **Next** buttons | ||
| and a total count of available libraries. | ||
|
|
||
| Clicking on a row brings you to the [specific library page](#library-page). | ||
|
|
||
| <a id="search"></a> | ||
|
|
||
| ## Search | ||
|
|
||
| Use the **Search** text input on the [initial display](#initial-display) to | ||
| narrow down the list of displayed libraries and locate a specific library. | ||
|
|
||
| TBD Say more about what search patterns are supported and such, this is currently changing | ||
| Currently works partial match on name (art) | ||
|
|
||
| TBD - feature-wise Needs some sort of progress display since its sometimes slow | ||
|
|
||
| Search results display identically to the [initial display](#initial-display) | ||
| but with a limited number of libraries. | ||
|
|
||
| Clicking on a row brings you to the [specific library page](#library-page). | ||
|
|
||
| <a id="library-page"></a> | ||
|
|
||
| ## Library Page | ||
|
|
||
| Access the library page by clicking on the row for a specific library in the | ||
| search results or the initial display page. | ||
|
|
||
| The title of the library page shows the name of the library and includes a text | ||
| input to filter the displayed library versions. | ||
|
|
||
| The list of library versions uses the following columns: | ||
|
|
||
| * **Version** - the version of the library. Library versions are strings. | ||
| Depending on the ecosystem and library they can follow naming patterns and | ||
| other restrictions that allow ordering by version. | ||
| * **Size** - TBD .. size of what? the jar , the pom, the war, probably should be | ||
| removed and used on the library version page that lists the files | ||
| * **Created** - TBD .. not sure what specific date that is, we should probably | ||
| change that to be the release date of the upstream release, when Chainguard | ||
| build a library could be a separate field but that might be less useful | ||
| * **Updated** - TBD .. not sure .... I think we should remove this, libraries | ||
| should not change so there should be no updated date | ||
|
|
||
| Click on the column titles to change the **sort** order of the list. | ||
|
|
||
| Clicking on a row brings you to the [specific library version | ||
| page](#library-version-page). | ||
|
|
||
| <a id="library-version-page"></a> | ||
|
|
||
| ## Library Version Page | ||
|
|
||
| TBD - does not exist yet Shows details about the library including list of | ||
| available files and ideally also some of the metadata like source URL or Python | ||
| specifics like supported glibc versions, operating systems | ||
|
|
||
| potentially add download feature for files | ||
|
|
||
| ## Java-specific Details ?? | ||
|
|
||
| TBD ? | ||
|
|
||
| jar file typically, also pom and others, probably also all the provenance and | ||
| signature files and such | ||
|
|
||
| ## Python-specific Details ?? | ||
|
|
||
| TBD? | ||
|
|
||
| wheel and sdist files, also for different operating systems and so on | ||
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.
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.
My understanding is "Created" is the date when Chainguard has started building a project (regardless if it's just 1 version, multiple versions). I don't see any issues with keeping this date, but we should have a tooltip or something that explains it.
"Updated" is confusing because I'd expect it would be the date when the latest version of a library was released by Chainguard, but we will often release older versions after later versions based on customer demand.
We may want to get some early customer and SE feedback on what they'd expect. cc @garrying as well for any thoughts
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.
What is the point of the created date is its just when we started building some version? Also .. why does it matter when we built it .. if a library is from 3 years ago .. and we started building it yesterday .. what point is there in knowing the date of yesterday? especially in a year .. when we have built numerous other versions ..
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.
I think we should discuss this with the ecosystem team and the console UI team .. I am not certain that showing any date here is useful .. and if there is maybe "Newest release date of upstream that we have available" and "Date of the most recent build from Chainguard for whatever version..including backfilling and old one" .. but maybe both of these should NOT be on this page but just standard fields for each version on the page for a specific library