docs: convert alerts to use GitHub Flavored Markdown (GFM) #16850
Conversation
| @@ -70,12 +67,9 @@ and specified quiet hours (see below). | |||
|
|
|||
| ### User quiet hours | |||
|
|
|||
| <blockquote class="info"> | |||
There was a problem hiding this comment.
anything with class info can use IMPORTANT? Thoughts?
There was a problem hiding this comment.
I set this one to note to align with the other an Enterprise and Premium features - really, they make sense as NOTE or TIP. Just depends on whether we want them to be blue or green, I guess. (note = blue; tip=green)
There was a problem hiding this comment.
@aqandrew for some reason both note and tip are showing up as blue for some reason.
@EdwardAngert Let's use badges on headings instead of license callouts.
There was a problem hiding this comment.
Lol I just realized that even though I copied the colors from GitHub, I use one of GitHub's colorblind UI themes (Dark Protanopia & Deuteranopia). It replaces green UI colors with blue.
I'll replace the colors with the ones from GitHub's default dark theme
There was a problem hiding this comment.
thanks for the pr to fix that, @aqandrew !
FWIW, I do prefer we default to using colorblind-friendly colors/themes wherever we can. Seems like an easy enough accommodation to help (+ soo many tools to help pick colors) the docs look and feel
| > [!IMPORTANT] | ||
| > To authenticate with the Artifactory registry, you may need to | ||
| > create a [Docker config](https://jfrog.com/help/r/jfrog-artifactory-documentation/docker-advanced-topics) and use it in the | ||
| > `imagePullSecrets` field of the Kubernetes Pod. | ||
| > See the [Defining ImagePullSecrets for Coder workspaces](../../tutorials/image-pull-secret.md) guide for more information. |
There was a problem hiding this comment.
it doesn't like this one for some reason 🤷
I'm playing with the indentation locally
current state:
There was a problem hiding this comment.
I have a hunch it's because this one is nested in an ordered list.
Was this fixed by ced07b4? If not, does it hurt the flow/semantics if we move the blockquote to be below the numbered list?
Should we just put the Enterprise label on the headings for such features? The Note looks way too noisy. Check this page for example. |
@matifali I was into it until I copied the URL to show you that it does look nice. now I'm torn - is there a way to make the site scrub the heading URLs on build? I remember we had removed this from some headings https://coder.com/docs/@16761-gfm-callouts/admin/external-auth#multiple-external-providers-enterprisepremium
|
|
I need to put this down for a little bit I'm using this regex to find all lines in md files in the ^> (?!\[!)We seem to overuse the blockquotes, so I've removed them wherever I can, but there's probably more we could edit with time.
|
| > [!NOTE] | ||
| > Workspace proxies are an Enterprise and Premium feature. | ||
| > [Learn more](https://coder.com/pricing#compare-plans). |
There was a problem hiding this comment.
| > [!NOTE] | |
| > Workspace proxies are an Enterprise and Premium feature. | |
| > [Learn more](https://coder.com/pricing#compare-plans). |
Instead use label on the heading.
There was a problem hiding this comment.
leaving out of this PR per #16850, slack discussion, and other comments - the way the site renders the anchor URL with $heading-enterpriselocal becomes another issue for search and heading redirects. If we can find a way for the site to scrub those from the URL when it generates pages, that's worth pursuing.
Alternatively, we can consider making the whole section something like "Everything from here down requires a license..."
There was a problem hiding this comment.
Approving for now. We will address the Notes to Label transition later.
cc: @EdwardAngert
Co-authored-by: M Atif Ali <atif@coder.com>
followup to #16761
thanks @lucasmelin !
preview (and others)