You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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?
The text was updated successfully, but these errors were encountered:
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.
Do we have any standardized guidelines for when to use the different admonition levels?
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?
The text was updated successfully, but these errors were encountered: