Add details labels to the docs #125
Merged
Conversation
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
felipecruz91
commented
Apr 7, 2022
| @@ -1,12 +1,16 @@ | |||
| Labels are specified in the extension's `Dockerfile` and are use to provide information about the extension. | |||
|
|
|||
| | Label | Required | Description | Example | | |||
| | Label <div style="width:300px"></div>| Required | Description | Example | | |||
There was a problem hiding this comment.
Added a fixed width to the label column so the label value can be displayed properly.
gtardif
reviewed
Apr 7, 2022
docs/extensions/labels.md
Outdated
| | `com.docker.extension.screenshots` | No | A list of images in the shape of comma-separated URLs to be displayed in the details dialog, in the order on which they’ve been defined. | `https://foo.bar/image1.png,https://foo.bar/image2.jpg` | | ||
| | `com.docker.extension.detailed-description` | No | Additional information in plain text or HTML about the extension to be displayed in the details dialog. | `My detailed description` or `<h1>My detailed description</h1>` | | ||
| | `com.docker.extension.publisher-url` | No | The publisher website URL to be displayed in the details dialog. | `https://foo.bar` | | ||
| | `com.docker.extension.additional-urls` | No | A list of additional URLs to be displayed displayed in the details dialog, in the order on which they’ve been defined. | `[{"title":"Twitter profile","url":"https://twitter.com/john"},{"title":"Sponsor my work","url":"https://github.com/sponsor/john"}]` | |
There was a problem hiding this comment.
This is where I would change the examples to propose "Documentation", "Support", "Terms of services" links. And maybe in the text details, mention the 4 typical ones we have thought about
There was a problem hiding this comment.
I've updated the copy and the examples, thanks
felipecruz91
force-pushed
the
feature/details-labels
branch
from
2eaa171 to
74358e2
Compare
gtardif
approved these changes
Apr 7, 2022
benja-M-1
requested changes
Apr 7, 2022
Co-authored-by: Benjamin Grandfond <benjamin.grandfond@gmail.com>
benja-M-1
approved these changes
Apr 8, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-materialVisit: http://0.0.0.0:8000/extensions/labels/