Skip to content

chore: Add missing code fence languages - #772

Merged
hubwriter merged 7 commits into
github:mainfrom
nschonni:code-fence-languages
Jan 18, 2021
Merged

chore: Add missing code fence languages#772
hubwriter merged 7 commits into
github:mainfrom
nschonni:code-fence-languages

Conversation

@nschonni

@nschonninschonni commented Oct 24, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor

Why:

Adding the language to the code fences adds syntax highlighting to the samples making them easier to read and can sometimes show syntax errors. The languages can also allow other tools like ESLint/Prettier to format those blocks if they know how to handle them based on the language

What's being changed:

Adding the code languages that are supported by the current syntax highlight library

Check off the following:

@nschonni
nschonniforce-pushed the code-fence-languages branch 2 times, most recently from b844a47 to 5ba67b3CompareOctober 24, 2020 03:14
@janiceilene

janiceilene commented Oct 28, 2020

Copy link
Copy Markdown
Contributor

👋 @nschonni Thanks for opening a PR! Is this still in progress? When you're ready for review, can you fill out the pull request template and let me know? Then I'll get it triaged for you!

@janiceilenejaniceilene added the hacktoberfest-accepted We might not merge this PR before Nov 1st, but it's a wonderful Hacktoberfest contribution! label Oct 28, 2020
@nschonni

nschonni commented Oct 28, 2020

Copy link
Copy Markdown
ContributorAuthor

@janiceilene I've checked the checkboxes now

@janiceilene

janiceilene commented Oct 28, 2020

Copy link
Copy Markdown
Contributor

@nschonni Could you fill out the Why? and What's being changed: sections to help ensure that this is triaged to the right team(s) for review, thanks!

@nschonni

nschonni commented Oct 28, 2020

Copy link
Copy Markdown
ContributorAuthor

@janiceilene done

@amt30uamt30u mentioned this pull request Oct 28, 2020
Closed
4 tasks
@janiceilenejaniceilene added the engineering Will involve Docs Engineering label Oct 28, 2020
@chiedochiedo added triage Do not begin working on this issue until triaged by the team and removed engineering Will involve Docs Engineering labels Nov 3, 2020
@chiedo

chiedo commented Nov 3, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor

@janiceilene I think this should be reviewed by someone on the content team! Looks good to me! But with it being a bunch of content changes, I'll defer.

@janiceilene

janiceilene commented Nov 3, 2020

Copy link
Copy Markdown
Contributor

Thanks @chiedo! I'll triage it for a writer review.

@janiceilenejaniceilene added the content This issue or pull request belongs to the Docs Content team label Nov 3, 2020
@rachmarirachmari removed the triage Do not begin working on this issue until triaged by the team label Nov 5, 2020
rachmari
rachmari reviewed Nov 5, 2020
View reviewed changes

@rachmarirachmari left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@nschonni I've reviewed the first 13 files in the PR and there are a couple of instances where the code fence removes some information, particularly information in brackets. Can take a look at those instances and any other instances that might be affected and make the appropriate fix? Then I can take a look at this again. 🙏 💚

Comment threadcontent/actions/creating-actions/setting-exit-codes-for-actions.md Outdated
Comment threadcontent/admin/enterprise-management/evacuating-a-cluster-node.md Outdated
@github-actions

github-actionsBot commented Nov 12, 2020

Copy link
Copy Markdown
Contributor

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

@github-actionsgithub-actionsBot added the stale There is no recent activity on this issue or pull request label Nov 12, 2020
@nschonni

nschonni commented Nov 16, 2020

Copy link
Copy Markdown
ContributorAuthor

Go away stale bot

@chiedo

chiedo commented Nov 16, 2020

Copy link
Copy Markdown
Contributor

Coming soon! #1386

@chiedochiedo added never-stale Do not close as stale and removed stale There is no recent activity on this issue or pull request labels Nov 16, 2020
hubwriter
hubwriter reviewed Jan 12, 2021
View reviewed changes
Comment threadcontent/actions/creating-actions/dockerfile-support-for-github-actions.md Outdated
hubwriter
hubwriter approved these changes Jan 12, 2021
View reviewed changes

@hubwriterhubwriter left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

As this has been sitting here for a while, I've gone ahead and added the raw and endraw markers requested by @rachmari.

@rachmari - could you take another look at this? It would be good to get this merged.

@nschonni - Thanks for raising this PR. 👍

@hubwriter

hubwriter commented Jan 12, 2021•
edited
Loading

Copy link
Copy Markdown
Contributor

A little investigation needed here before we can merge this.

The {% raw %} ... {% endraw %} markers appear not to be working on the staging deployment (e.g. see step 2 here).

@rachmari

rachmari commented Jan 17, 2021

Copy link
Copy Markdown
Contributor

@hubwriter I'd say that we could just remove the language from the code examples that aren't rendering properly and we can file an issue for any that we can look into the cause for later. I'm not sure when we'll have time to investigate the cause and file an issue with the upstream library, but at least we can ship the updates that are working for us now.

@hubwriter
Remove language from code fences
73329f7
to avoid the problem of replaceable text indicates like
<this> not showing up in the output page.
@hubwriter

hubwriter commented Jan 18, 2021

Copy link
Copy Markdown
Contributor

I've removed the language from the opening code fence where the code wasn't rendering properly on the output page.

@hubwriter

hubwriter commented Jan 18, 2021

Copy link
Copy Markdown
Contributor

@nschonni - Thanks again for working on this. Apologies it's taken us so long to get it merged.
It's going in now! 😃

@hubwriter
hubwriter merged commit d9167f1 into github:mainJan 18, 2021
@github-actions

github-actionsBot commented Jan 18, 2021

Copy link
Copy Markdown
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours.

@nschonni
nschonni deleted the code-fence-languages branch January 18, 2021 16:22
jnidzwetzki pushed a commit to jnidzwetzki/docs that referenced this pull request Oct 6, 2022
@Loquacity@jacobprall@charislam
Add OOM killer info (github#772)
2e3aaad
* Add OOM killer info
* Move OOM killer to new memory mgmt section & edit
* postgres -> postgresql
* Apply suggestions from code review
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
* Update cloud/memory-management.md
Co-authored-by: Jacob Prall <prall.jacob@gmail.com>
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hubwriterhubwriterhubwriter approved these changes
+1 more reviewer
@rachmarirachmarirachmari left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

contentThis issue or pull request belongs to the Docs Content teamhacktoberfest-acceptedWe might not merge this PR before Nov 1st, but it's a wonderful Hacktoberfest contribution!never-staleDo not close as stale

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@nschonni@janiceilene@chiedo@hubwriter@rachmari