Skip to content

Commit 4acf85b

Browse files
authored
Specify using the base64 value for quick start icons (#497)
1 parent 463a416 commit 4acf85b

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

CONTRIBUTING.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,6 @@ A schema for `quickstart.yml` is provided in `quickstart.schema.json`. To load t
110110
* Follow link:https://www.jetbrains.com/help/idea/json.html#ws_json_schema_add_custom[this guide for IntelliJ], use `**/quickstart.yml` as the file path pattern
111111
* Install link:https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml[the YAML extension for VS Code], follow the documentation to associate the schema to `**/quickstart.yml`
112112

113-
=== Previewing the quick starts locally
114113

115114
You can preview the quick start catalog and the quick start pages locally. (Note that the preview shows _all_ of the quick starts in the `app-services-guides` repository, not just one quick start.)
116115

@@ -157,15 +156,15 @@ kind: QuickStarts
157156
metadata:
158157
name: <identifier>
159158
----
160-
. The `spec` associative array defines the quick start content. Start by defining the content type of the quickstart (Quick start / Documentation), the version of the quick start, the URL of an icon to use, and how long the quick start should take to complete.
159+
. The `spec` associative array defines the quick start content. Start by defining the content type of the quickstart (Quick start / Documentation), the version of the quick start, the base64 value of an icon to use, and how long the quick start should take to complete.
161160
+
162161
----
163162
spec:
164163
version: <quick start version>
165164
type:
166165
text: Quick start // or Documentation if it has an external link
167166
color: green // orange for Documentation
168-
icon: <icon url>
167+
icon: data:image/svg+xml;base64,<base64-string> // you can find the base64 string here: https://base64.guru/converter/encode/image
169168
durationMinutes: <duration>
170169
----
171170
+

0 commit comments

Comments
 (0)