Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Request: standardize admonition levels #754

Closed
kenjenkins opened this issue Jun 20, 2023 · 1 comment
Closed

Request: standardize admonition levels #754

kenjenkins opened this issue Jun 20, 2023 · 1 comment
Labels

Comments

@kenjenkins
Copy link
Contributor

Do we have any standardized guidelines for when to use the different admonition levels?
Screen Shot 2023-06-20 at 11 27 53 AM

My preference would be to reserve 'Danger' for cases where there are clear security implications.

Example

As one specific example, take this page: https://www.pomerium.com/docs/reference/certificates#certificate-authority

What's incorrect or missing

There's a DANGER admonition with the message: "Be sure to include the intermediary certificate."

My understanding is that the worst that will happen here is that Pomerium won't work at all. While that's certainly bad, to me that doesn't seem like "danger" in nearly the same way as say, exposing routes to unauthenticated users (https://www.pomerium.com/docs/reference/routes/public-access#how-to-configure), which doesn't currently have any of the Docusaurus admonition formatting.

What's the resolution?

Could we document some guidelines for when to use which admonition, and make sure these are used consistently throughout our documentation?

@Rajakavitha1
Copy link

Hi @kenjenkins, The standard format that is followed in Technical writing is https://developers.google.com/style/notices. Danger is certainly not an admonition that we use in software product documentation because it is for content that describes situations that could result in physical injury or death.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants