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 note on gh-pages for formatting within <details> block #34567

Closed
wants to merge 1 commit into from

Conversation

nisbet-hubbard
Copy link

@nisbet-hubbard nisbet-hubbard commented Sep 12, 2024

Why:

Markdown formatting doesn’t render properly for gh-pages.

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

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.

Copy link

welcome bot commented Sep 12, 2024

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

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

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
get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10

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

@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 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 12, 2024
@nguyenalex836
Copy link
Contributor

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

@subatoi
Copy link
Contributor

subatoi commented Sep 12, 2024

Hi @nisbet-hubbard, could I ask which renderer you were trying to use (that prompted this suggestion)? Was it Jekyll? Many thanks.

@nguyenalex836 nguyenalex836 added the more-information-needed More information is needed to complete review label Sep 12, 2024
@nisbet-hubbard
Copy link
Author

Yes, it was Jekyll!

@subatoi
Copy link
Contributor

subatoi commented Sep 16, 2024

Thank you—I think this covers the same issue: #32988

Because of 32988, we've got an issue in our backlog that we'd like to complete internally. The solution we agreed on (that is, adding product callouts) will affect quite a few different pages when we implement it.

I'll copy @nguyenalex836 in case I've missed something, but I'm afraid we'll need to close this in favour of our internal issue (I'll raise its priority). Thank you for your interest in the Docs and helping other users 🙏

@subatoi subatoi closed this Sep 16, 2024
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 more-information-needed More information is needed to complete review 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.

3 participants