[WIP] Add docs for Chainguard Libraries on console UI #2373
Conversation
✅ Deploy Preview for ornate-narwhal-088216 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
mosabua
force-pushed
the
browse
branch
3 times, most recently
from
d663edf to
d51eb54
Compare
| `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 |
There was a problem hiding this comment.
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.
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.
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
Signed-off-by : Manfred Moser <manfred@simpligility.ca>
2 participants
Type of change
What should this PR do?
Provide minimal docs for first iteration that is made available to customers.
Fix https://github.com/chainguard-dev/internal/issues/5106
WIP since this is all in development and refinement for now.
Why are we making this change?
UI without docs is good, but with docs is better.
What are the acceptance criteria?
Documents functionality as it goes live to first customers.
How should this PR be tested?
Verify against the console to confirm the docs reflect the UI.