Skip to content

Commit

Permalink
Add topic doc image
Browse files Browse the repository at this point in the history
  • Loading branch information
JakeSCahill committed Nov 12, 2024
1 parent 1fdb112 commit fbc89a2
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 1 addition & 1 deletion modules/console/pages/config/topic-documentation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

You can embed your topic's documentation into the Redpanda Console user interface by providing access to a public or private Git repository that hosts your documentation files in Markdown format.

//image::topic-documentation.png[]
image::topic-documentation.png[]

Redpanda Console clones the provided Git repository and stores all Markdown files it finds in memory.
The *Documentation* tab in the frontend displays the content of the Markdown file that matches the name of the Kafka topic.
Expand Down
2 changes: 2 additions & 0 deletions modules/console/pages/quickstart.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -144,12 +144,14 @@ Suppose you're asked to find all transactions related to the `.edu` domain. You
// (step {"action":"saveScreenshot", "path": "js-filter.png", "directory": "../images", "overwrite": "byVariation", "maxVariation": 10})
+
image::js-filter.png[]

. Replace the default JavaScript code with the following:
+
[,js]
----
return value.email.includes(".edu");
----

. Click *Save* to apply the filter.
// (step {"action":"find", "selector": "[data-testid='add-javascript-filter-save']", "matchText": "Save", "click": true})
+
Expand Down

0 comments on commit fbc89a2

Please sign in to comment.