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

Add blockquote to Basic writing and formatting syntax #27902

Closed
1 task done
jsoref opened this issue Aug 31, 2023 · 4 comments · Fixed by #28140
Closed
1 task done

Add blockquote to Basic writing and formatting syntax #27902

jsoref opened this issue Aug 31, 2023 · 4 comments · Fixed by #28140
Labels
content This issue or pull request belongs to the Docs Content team get started Content related to "Getting Started" doc set waiting for review Issue/PR is waiting for a writer's review

Comments

@jsoref
Copy link
Contributor

jsoref commented Aug 31, 2023

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts

What changes are you suggesting?

  1. Add blockquote to the article
  2. Ensure that searching for note+warning+blockquote+markdown finds the article (and not on page 9/10).

Additional information

In https://github.com/orgs/community/discussions/16925#discussioncomment-6876291, I wrote:

there's no sign of documentation for this feature

The feature announcement https://github.com/orgs/community/discussions/16925 is titled [Markdown] An option to highlight a "Note" and "Warning" using blockquote

It's reasonable to expect a search for note+warning+blockquote+markdown to turn it up. Indeed, 3/4 of those search terms are present on https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax -- only blockquote is missing.

@jsoref jsoref added the content This issue or pull request belongs to the Docs Content team label Aug 31, 2023
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Aug 31, 2023
@cmwilson21
Copy link
Contributor

@jsoref Thanks for opening an issue! I'll get it triaged 👍

@cmwilson21 cmwilson21 added waiting for review Issue/PR is waiting for a writer's review get started Content related to "Getting Started" doc set and removed triage Do not begin working on this issue until triaged by the team labels Sep 1, 2023
@felicitymay
Copy link
Contributor

Thanks for flagging this @jsoref

Your suggestion makes a lot of sense. I'll update the issue summary with a brief content design plan and label the issue for the upcoming Hacktoberfest.

@felicitymay
Copy link
Contributor

On reflection, I opened a PR because we already have a help-wanted issue for this section of the article and it would be good to avoid OS contributors have conflicts in their work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team get started Content related to "Getting Started" doc set waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants
@felicitymay @jsoref @cmwilson21 and others