mirror of
https://github.com/OliveTin/OliveTin
synced 2026-08-24 03:26:39 +00:00
chore: frontend unit tests
This commit is contained in:
@@ -32,6 +32,8 @@ actions:
|
||||
type: ascii_sentence
|
||||
----
|
||||
|
||||
`description` is optional help text under the field. It is rendered as raw HTML; see xref:args/intro.adoc#arg-descriptions[Argument descriptions].
|
||||
|
||||
This will give you a normal button, like this;
|
||||
|
||||
image::args/input/args1.png[]
|
||||
|
||||
@@ -10,6 +10,24 @@ Examples of valid argument names are `{{ personName }}`, `{{ customer_number }}`
|
||||
* numbers are allowed (argument names can also start with numbers)
|
||||
* all other characters are invalid for argument names.
|
||||
|
||||
[#arg-descriptions]
|
||||
== Argument descriptions
|
||||
|
||||
Each argument can include a `description:` shown under the field on the argument form. OliveTin renders that value as **raw HTML**, so you can use markup such as links, line breaks, or emphasis:
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
arguments:
|
||||
- name: host
|
||||
title: Hostname
|
||||
type: ascii_identifier
|
||||
description: |
|
||||
Enter a host OliveTin can reach.
|
||||
See the <a href="https://example.com/docs" target="_blank" rel="noopener noreferrer">network guide</a>.
|
||||
----
|
||||
|
||||
Treat `description` as trusted markup that you control (the same trust model as xref:dashboards/4-displays.adoc[dashboard displays]). Do not put untrusted or entity-derived strings into it without careful escaping.
|
||||
|
||||
== What's Next?
|
||||
|
||||
Now that you understand how arguments work, explore the different argument types and features:
|
||||
|
||||
Reference in New Issue
Block a user