#!/bin/bash
# info: Generate Lets Encrypt certificate for provided domain and aliases.
# options: USER DOMAIN [ALIASES] [MAIL]
# variable: ALIASES | Comma separated list of aliases to be addd to the certificate this could contain up to 100 different domains / subdomain need to be under "ALIASES" under web
# variable: MAIL | Enable Lets encrypt from mail and webmail
# example: v-add-letsencrypt-domain user domain.com 'www.domain.com,demo.domain.com'
# example: v-add-letsencrypt-domain user domain.com '' yes
# Optional comments can still be made how ever not mixed with examples
# note: Wildcard domains *.domain.com are supported only when DNS via Hestia is used.
#!/bin/bash
# info: General info regarding the function / script
# options: Options used
# variable: Option name | Explaination regarding it can be multiple
# example: script name option1 option2 option3 can be multiple
# Optional comments can still be made how ever not mixed with examples
# note: Displayed in :::warning box in vite press :::
Might place # note: with # info: and # warning:
Edit: # info can’t be used twice so kept note instead…
If possible, a way to markup options line with default i.e. [RESTART:no]. While I know this can also be done on a variable line, but as a personal preference, I like knowing what the default behavior will be at a glance.
If possible, full markdown/linebreak support in all sections would be helpful; when I played around with this linebreaks didn’t work and markdown only sometimes worked. I know you said you didn’t want to use markdown/vitepress the bash comments so I appreciate you adding it here to note section.
If possible, full markdown/linebreak support in all sections would be helpful; when I played around with this linebreaks didn’t work and markdown only sometimes worked. I know you said you didn’t want to use markdown/vitepress the bash comments so I appreciate you adding it here to note section.
Have added both: “note” and “warning” for example:
Note for “usefull” information for example: Wildcard *.domain.com is also a valid alias when you use Hestia DNS…
Warning: When Disableling DNS it might break the domain …
Yes. Having some sort of type indicator would be better even though the system is not adhering to strict data types. It sounds like you see the cli document issues, you are on board with improving it and since you are the one that is going to mod the doc generator, please do what you think is best.
GENERIC CLI SECTION
I think we have a misunderstanding. I mean generic section related to cli usage, NOT how to create cli documentation For example, info from this post: [Feature] CLI Documentation FORMAT · Issue #4215 · hestiacp/hestiacp · GitHub
show details about output types. This doesn’t needed to be included in every cli command documentation subsection because this is common information. Only output types would be included in the subsection. Your [RESTART] info below is another example i.e.
Yes. Just saying linebreaks and some other markdown doesn’t work properly when doc generated. Not a big deal, but would be nice.
WRAPPED LINES
Sounds good. Then you can remove the line " * the description is mandatory, delimited with empty line and consists of sentences wrapped for 80 width limit, each line is prepended with # from GitHub - hestiacp/hestia-cli-docs
Thanks for that explanation. I never understood how that worked. I also think the original developers should have used bash command flag functionality for that one anyway i.e. -r [restart]. But not something that I think is worth changing now.
Thanks for that explanation. I never understood how that worked. I also think the original developers should have used bash command flag functionality for that one anyway i.e. -r [restart]. But not something that I think is worth changing now.
It is discussed In the past but a shit ton of work…
