I set this one tonote to align with the otheran Enterprise and Premium features - really, they make sense asNOTE orTIP. Just depends on whether we want them to be blue or green, I guess. (note = blue; tip=green)

Copy link

Member

matifaliMar 7, 2025

Choose a reason for hiding this comment

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

@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.

Copy link

aqandrewMar 7, 2025

Choose a reason for hiding this comment

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

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

Copy link

ContributorAuthor

EdwardAngertMar 10, 2025•
edited
Loading

Choose a reason for hiding this comment

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

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

matifali reviewed

Mar 7, 2025

View reviewed changes

docs/admin/integrations/jfrog-xray.md Outdated

Comment on lines 59 to 63

		> [!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.

Copy link

Member

matifaliMar 7, 2025•
edited
Loading

Choose a reason for hiding this comment

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

❤️

Copy link

ContributorAuthor

EdwardAngertMar 7, 2025

Choose a reason for hiding this comment

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

it doesn't like this one for some reason 🤷

I'm playing with the indentation locally

current state:

Copy link

aqandrewMar 7, 2025

Choose a reason for hiding this comment

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

I have a hunch it's because this one is nested in an ordered list.

Was this fixed byced07b4? If not, does it hurt the flow/semantics if we move the blockquote to be below the numbered list?

matifali previously approved these changes

Mar 7, 2025

View reviewed changes

Copy link

Member

matifali left a comment

Choose a reason for hiding this comment

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

Thanks a ton Edward. ❤️

Copy link

Member

matifali commentedMar 7, 2025•
edited
Loading

Should we just put the Enterprise label on the headings for such features? The Note looks way too noisy. Checkthis page for example.

EdwardAngert added3 commits

March 7, 2025 19:47

blockquote indentation

ced07b4

test premium badge in external-auth

1eaeab8

alert spacing

48cf62b

Copy link

ContributorAuthor

EdwardAngert commentedMar 7, 2025•
edited
Loading

Should we just put the Enterprise label on the headings for such features? The Note looks way too noisy. Check [this](https://coder.com/docs/@16761-gfm-callouts/admin/templates/managing-templates/schedule) 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 headingshttps://coder.com/docs/@16761-gfm-callouts/admin/external-auth#multiple-external-providers-enterprisepremium

EdwardAngert added2 commits

March 7, 2025 19:54

un-nest alert from OL

ca70325

more > Note

0dab25c

matifali reviewed

Mar 7, 2025

View reviewed changes

docs/admin/users/github-auth.md OutdatedShow resolvedHide resolved

edit blockquotes

af0fdd8

Copy link

ContributorAuthor

EdwardAngert commentedMar 7, 2025

I need to put this down for a little bit

I'm using this regex to find all lines in md files in thedocs directory that start with> but not> [! which still returns all the second+ lines in correctly formatted alerts, but is a little less, I guess:

^>(?!\[!)

We seem to overuse the blockquotes, so I've removed them wherever I can, but there's probably more we could edit with time.

only 83 files to go!

matifali dismissed theirstale review

March 7, 2025 21:07

Stale

EdwardAngert added2 commits

March 10, 2025 15:25

Update template-from-scratch.md document

6b4d36a

edit or remove non GFM blockquote alerts

06c8b36

EdwardAngert changed the title~~docs: update alerts to use GFM~~docs: convert alerts to use GitHub Flavored Markdown (GFM)

Mar 10, 2025

EdwardAngert commented

Mar 10, 2025

View reviewed changes

docs/admin/users/github-auth.md OutdatedShow resolvedHide resolved

EdwardAngert requested a review frommatifali

March 10, 2025 16:37

matifali approved these changes

Mar 10, 2025

View reviewed changes

matifali requested changes

Mar 10, 2025

View reviewed changes

docs/admin/templates/managing-templates/index.mdShow resolvedHide resolved

docs/CONTRIBUTING.md OutdatedShow resolvedHide resolved

docs/admin/integrations/opentofu.mdShow resolvedHide resolved

docs/admin/networking/index.md

Comment on lines +191 to +193

		> [!NOTE]
		> Workspace proxies are an Enterprise and Premium feature.
		> [Learn more](https://coder.com/pricing#compare-plans).

Copy link

Member

matifaliMar 10, 2025

Choose a reason for hiding this comment

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

Suggested change

	>[!NOTE]
	>Workspace proxies are an Enterprise and Premium feature.
	>[Learn more](https://coder.com/pricing#compare-plans).

Instead use label on the heading.

Copy link

ContributorAuthor

EdwardAngertMar 10, 2025

Choose a reason for hiding this comment

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

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..."

docs/admin/networking/port-forwarding.mdShow resolvedHide resolved

docs/user-guides/workspace-access/index.md OutdatedShow resolvedHide resolved

docs/user-guides/workspace-scheduling.mdShow resolvedHide resolved

matifali requested changes

Mar 10, 2025

View reviewed changes

Copy link

Member

matifali left a comment

Choose a reason for hiding this comment

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

Excessive use of Note that its a paid feature. We should use the labels more.

matifali approved these changes

Mar 10, 2025

View reviewed changes

Copy link

Member

matifali left a comment•
edited
Loading

Choose a reason for hiding this comment

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

Approving for now. We will address the Notes to Label transition later.
cc:@EdwardAngert

EdwardAngertand others added2 commits

March 10, 2025 15:05

Apply suggestions from code review

1735d16

Co-authored-by: M Atif Ali <atif@coder.com>

close codeblock

e527a53

EdwardAngert merged commit101b62d intomain

Mar 10, 2025

28 checks passed

EdwardAngert deleted the 16761-gfm-callouts branch

March 10, 2025 20:58

github-actionsbot locked and limited conversation to collaborators

Mar 10, 2025

Labels

docs/site

docs site-related issue/task/feature request

docs

Area: coder.com/docs

3 participants

Movatterモバイル変換

docs: convert alerts to use GitHub Flavored Markdown (GFM)#16850

docs: convert alerts to use GitHub Flavored Markdown (GFM)#16850

Conversation

EdwardAngert commentedMar 7, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

EdwardAngertMar 10, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

matifaliMar 7, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

matifali left a comment

Choose a reason for hiding this comment

Uh oh!

matifali commentedMar 7, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

EdwardAngert commentedMar 7, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

Uh oh!

EdwardAngert commentedMar 7, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

matifali left a comment

Choose a reason for hiding this comment

Uh oh!

matifali left a comment• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

EdwardAngert commentedMar 7, 2025•
edited
Loading

EdwardAngertMar 10, 2025•
edited
Loading

matifaliMar 7, 2025•
edited
Loading

matifali commentedMar 7, 2025•
edited
Loading

EdwardAngert commentedMar 7, 2025•
edited
Loading

matifali left a comment•
edited
Loading