Skip to content

Add extra explanation to wildcard glossary about base domain - #661

Merged
alexzorin merged 6 commits into
certbot:masterfrom
osirisinferi:append-wildcard-glossary
Oct 18, 2020
Merged

Add extra explanation to wildcard glossary about base domain#661
alexzorin merged 6 commits into
certbot:masterfrom
osirisinferi:append-wildcard-glossary

Conversation

@osirisinferi

Copy link
Copy Markdown
Contributor

Fixes #660

@alexzorin alexzorin added the docs label Oct 8, 2020
alexzorin
alexzorin previously approved these changes Oct 15, 2020

@alexzorin alexzorin left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Big agree on this change, thanks.

Would you be interested in rewriting the first sentence as well? I have a lot of trouble myself understanding what it says.

If not, I'm happy to just merge this.

@alexzorin alexzorin left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are great - they all come up frequently.

  1. Annoyingly, because this is markdown, many of the asterisks are being interpreted as emphasis. Could you please escape each of them as \*?
  2. Let's split these explanations into 4 or 5 paragraphs

@osirisinferi

Copy link
Copy Markdown
Contributor Author

I'll try to learn Markdown in that case first.

@alexzorin

Copy link
Copy Markdown
Collaborator

If you want a convenient way to see how it will be rendered (without actually starting this project up), the forums also use markdown.

So you can just paste the text there and the forum post preview will faithfully render it, including the magic asterisks.

@osirisinferi

Copy link
Copy Markdown
Contributor Author

Also reworded some parts a little bit to make it more clear (I think).

@alexzorin alexzorin left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some small nits and simplifications.

My suggested change of "Hostname"→"Name" might confuse novice readers, I'm not sure. But the idea of a wildcard hostname didn't feel good to me.

Comment thread _terms/wildcard-certificate.md Outdated
Comment thread _terms/wildcard-certificate.md Outdated
Comment thread _terms/wildcard-certificate.md Outdated
osirisinferi and others added 3 commits October 18, 2020 10:03
Co-authored-by: alexzorin <alex@zor.io>
Co-authored-by: alexzorin <alex@zor.io>
Co-authored-by: alexzorin <alex@zor.io>

@alexzorin alexzorin left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot, I think this is a huge improvement.

One of the wildcard tooltips has messed up formatting, but since that was already an issue before, let's fix that separately.

@alexzorin
alexzorin merged commit 5e4d455 into certbot:master Oct 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Current wildcard glossary not clear to users about the base domain

2 participants