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

Acknowledge that the available parsers are not compatible with GitHub… #35258

Merged
merged 3 commits into from
Nov 13, 2024

Conversation

jsoref
Copy link
Contributor

@jsoref jsoref commented Nov 11, 2024

…'s markdown

Why:

Closes: #34334

What's being changed (if available, include any code snippets, screenshots, or gifs):

before

image

after

image

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 11, 2024
Copy link
Contributor

github-actions bot commented Nov 11, 2024

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

@jsoref
Copy link
Contributor Author

jsoref commented Nov 11, 2024

This PR is frustrating. It's virtually impossible for me to imagine any text that properly explains what's going on and I really wish the GitHub product team would take responsibility for writing the text instead of asking a community member to try to politely say that their stuff doesn't do what it used to claim to do.

The year is a rough estimate and is partially designed to give people a sense of how out of date the two systems might be. I know that stuff from 2021 isn't supported. For all I know it was out of date in 2016 or 2010.

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review pages Content related to GitHub Pages and removed triage Do not begin working on this issue until triaged by the team labels Nov 11, 2024
@nguyenalex836
Copy link
Contributor

@jsoref Thanks so much for opening a PR! I'll get this triaged for review ✨

@nguyenalex836
Copy link
Contributor

@jsoref Hello! 👋 After reviewing your PR, our team would like to update the wording to read:

You can use {% data variables.product.prodname_dotcom %} Flavored Markdown with either processor.

This will provide the reader sufficient information without overloading them with too much context. Let us know if you have any concerns 💛 Otherwise, we can update this PR in a few days and get this merged ✨

@nguyenalex836
Copy link
Contributor

@jsoref Thank you for updating your PR! Getting this merged shortly 💛

@nguyenalex836 nguyenalex836 added this pull request to the merge queue Nov 13, 2024
Merged via the queue into github:main with commit eb5c0d2 Nov 13, 2024
45 checks passed
Copy link
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. If you're looking for your next contribution, check out our help wanted issues

@jsoref jsoref deleted the issues-34334 branch November 13, 2024 16:37
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 pages Content related to GitHub Pages waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Jekyll GFM processor claims it "will always match the results you see on GitHub"
2 participants