acme.sh-dns: add page; acme.sh: remove example

[peterbabic]

The wildcard went completely missing somewhere before the merge. In the original design, wildcard certificate usage was about to be referenced with a manual mode example. Running a manual mode with the current example would not produce a wildcard certificate because of the missing *. subdomain. Furthermore, it would not do anything because a manual DNS mode requires a sort of confirmation command, more info acmesh-official/acme.sh#1029. Because of the many quirks of the various DNS modes, a separate subcommand page acme.sh dns was created.

[tldr-bot]

The build for this PR failed with the following error(s):

pages/common/acme.sh-dns.md:4: TLDR004 Command descriptions should end in a period

Please fix the error(s) and push again.

[peterbabic]

Guys, additionally, should we also mention custom scripts, I have described in #5823 (comment)

It would almost certainly require referencing a path in the example description and I am not sure if we do that. Without the actual path the example does not make much sense.

[marchersimon]

I don't think that should be a problem.

[sbrl]

In tldr pages we generally try to only document the most common functionality in a page - it's an exercise in determining what's most important. So while custom scripts might be a very useful feature, it sounds like advanced functionality that doesn't necessarily need documenting here. Perhaps it would be more useful in a long-form guide or tutorial rather than a concise set of examples like tldr pages?

[sbrl]

Thanks for the edit and new page! I've left some comments below for you to review.

[peterbabic]

So while custom scripts might be a very useful feature, it sounds like advanced functionality that doesn't necessarily need documenting here

@sbrl Agreed.

@marchersimon above + can you provide an existing example/discussion of a good way to insert a path into the page, for a possible future use (only if you do not need to search for it for too long).

[sbrl]

Generally the convention with file paths is:

path/to/file is preferred, with the preferred extension after it if appropriate - e.g. path/to/file.txt

If the path must be absolute, then prepend a slash (the word absolute is suggested but not required): /absolute/path/to/file.txt

Generally speaking we drop the path/to/ bit if we need to specify lots of paths at once - e.g. tar

If you need to specify a variable number of paths, see #5791

[peterbabic]

@sbrl thank you. Do these convention apply to the actual text? Am I allowed to use backtics in the text to specify the path?

---- example below ----

• Issue a certificate using a custom DNS API script, placed by default at /root/.acme.sh/dns_custom.sh (useful when the API is not yet supported upstream):

acme.sh --issue --dns dns_custom --domain example.com

[marchersimon]

@peterbabic we actually use backticks in normal text a lot. Mostly when refering to a command or for URLs.

[sbrl]

Thanks, @peterbabic!