Files
opencloud/docs/templates/ADOC.tmpl
Martin 079fbfa850 Update docs/templates/ADOC.tmpl
Co-authored-by: Phil Davis <phil@jankaritech.com>
2024-07-12 16:18:09 +02:00

58 lines
1.2 KiB
Cheetah

// set the attribute to true or leave empty, true without any quotes.
// if the generated adoc file is used outside tabs, it renders correctly depending on the attribute set.
// if inside, you need to also use the xxx_deprecation.adoc file. attributes can't be defined inside tabs.
:show-deprecation: {{ .HasDeprecations }}
ifeval::[{show-deprecation} == true]
[#deprecation-note-{{ .Timestamp }}]
[caption=]
.Deprecation notes for the {{ .ExtensionName }} service
[width="100%",cols="~,~,~,~",options="header"]
|===
| Deprecation Info
| Deprecation Version
| Removal Version
| Deprecation Replacement
{{- range .Deprecations }}
| {{ .DeprecationInfo }}
| {{ .DeprecationVersion }}
| {{ .RemovalVersion }}
| {{ .DeprecationReplacement }}
{{- end }}
|===
{empty} +
endif::[]
[caption=]
.Environment variables for the {{ .ExtensionName }} service
[width="100%",cols="~,~,~,~",options="header"]
|===
| Name
| Type
| Default Value
| Description
{{- range .Fields}}
a| {{- range $i, $value := .EnvVars }}{{- if $i }} +
{{ end -}}
`{{- $value }}`
{{- end }} +
{{ .DeprecationLink }}
a| [subs=-attributes]
++{{.Type}} ++
a| [subs=-attributes]
++{{.DefaultValue}} ++
a| [subs=-attributes]
{{.Description}}
{{- end }}
|===