Skip to content

Commit 7d5aca1

Browse files
ashishkeshanfelicitymay
andauthoredJan 13, 2025··
Get remaining quotes from md files (#53858)
Co-authored-by: Felicity Chapman <[email protected]>
1 parent 95d266b commit 7d5aca1

File tree

87 files changed

+135
-135
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

87 files changed

+135
-135
lines changed
 

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ Use the table of contents icon <img alt="Table of contents icon" src="./contribu
99

1010
## Contributing
1111

12-
We accept different types of contributions, including some that don't require you to write a single line of code. For detailed instructions on how to get started with our project, see "[About contributing to GitHub Docs](https://docs.github.com/en/contributing/collaborating-on-github-docs/about-contributing-to-github-docs)."
12+
We accept different types of contributions, including some that don't require you to write a single line of code. For detailed instructions on how to get started with our project, see [About contributing to GitHub Docs](https://docs.github.com/en/contributing/collaborating-on-github-docs/about-contributing-to-github-docs).
1313

1414
### Ways to contribute
1515

1616
On the GitHub Docs site, you can contribute by clicking the **Make a contribution** button at the bottom of the page to open a pull request for quick fixes like typos, updates, or link fixes.
1717

18-
You can also contribute by creating a local environment or opening a Codespace. For more information, see "[Setting up your environment to work on GitHub Docs](https://docs.github.com/en/contributing/setting-up-your-environment-to-work-on-github-docs)."
18+
You can also contribute by creating a local environment or opening a Codespace. For more information, see [Setting up your environment to work on GitHub Docs](https://docs.github.com/en/contributing/setting-up-your-environment-to-work-on-github-docs).
1919

2020
<img alt="Contribution call-to-action" src="./contributing/images/contribution_cta.png" width="400">
2121

‎content/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ featuredLinks:
196196

197197
### `allowTitleToDifferFromFilename`
198198

199-
- Purpose: Indicates whether a page is allowed to have a title that differs from its filename. Pages with this frontmatter set to `true` will not be flagged in tests or updated by `src/content-render/scripts/reconcile-filenames-with-ids.js`. Use this value if a file's `title` frontmatter includes Liquid or punctuation that cannot be part of the filename. For example, the article "[About Enterprise Managed Users](https://docs.github.com/en/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)" uses a Liquid reusable in its title, `'About {% data variables.product.prodname_emus %}'`, which cannot be in the filename, `about-enterprise-managed-users.md`, so the `allowTitleToDifferFromFilename` frontmatter is set to `true`.
199+
- Purpose: Indicates whether a page is allowed to have a title that differs from its filename. Pages with this frontmatter set to `true` will not be flagged in tests or updated by `src/content-render/scripts/reconcile-filenames-with-ids.js`. Use this value if a file's `title` frontmatter includes Liquid or punctuation that cannot be part of the filename. For example, the article [About Enterprise Managed Users](https://docs.github.com/en/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users) uses a Liquid reusable in its title, `'About {% data variables.product.prodname_emus %}'`, which cannot be in the filename, `about-enterprise-managed-users.md`, so the `allowTitleToDifferFromFilename` frontmatter is set to `true`.
200200
- Type: `Boolean`. Default is `false`.
201201
- Optional.
202202

@@ -293,15 +293,15 @@ Do not add hardcoded "In this article" sections in the Markdown source or else t
293293
A content file can have **two** types of versioning:
294294

295295
- [`versions`](#versions) frontmatter (**required**)
296-
- Determines in which versions the page is available. See "[Versioning documentation](https://docs.github.com/en/contributing/writing-for-github-docs/versioning-documentation)" for more info.
296+
- Determines in which versions the page is available. See [Versioning documentation](https://docs.github.com/en/contributing/writing-for-github-docs/versioning-documentation) for more info.
297297
- Liquid statements in content (**optional**)
298-
- Conditionally render content depending on the current version being viewed. See "[Versioning documentation](https://docs.github.com/en/contributing/writing-for-github-docs/versioning-documentation#versioning-with-liquid-conditional-operators)" for more info. Note Liquid conditionals can also appear in `data` and `include` files.
298+
- Conditionally render content depending on the current version being viewed. See [Versioning documentation](https://docs.github.com/en/contributing/writing-for-github-docs/versioning-documentation#versioning-with-liquid-conditional-operators) for more info. Note Liquid conditionals can also appear in `data` and `include` files.
299299

300300
**Note**: As of early 2021, the `free-pro-team@latest` version is not included URLs. A helper function called `src/versions/lib/remove-fpt-from-path.js` removes the version from URLs.
301301

302302
## Filenames
303303

304-
When adding a new article, the filename is a [kebab-cased](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of the article's [`title`](#title) frontmatter. For example, the article "[About GitHub CLI](https://docs.github.com/en/github-cli/github-cli/about-github-cli)" has a `title` frontmatter of `About GitHub CLI` and a filename of `about-github-cli.md`.
304+
When adding a new article, the filename is a [kebab-cased](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of the article's [`title`](#title) frontmatter. For example, the article [About GitHub CLI](https://docs.github.com/en/github-cli/github-cli/about-github-cli) has a `title` frontmatter of `About GitHub CLI` and a filename of `about-github-cli.md`.
305305

306306
Directory names for categories and map topics can match the `title` or `shortTitle` frontmatter.
307307

@@ -383,7 +383,7 @@ You can link directly to a different version of the page using the `currentArtic
383383
Sometimes you want to link to a Dotcom-only article in Enterprise content and you don't want the link to be Enterprise-ified. To prevent the transformation, you should include the preferred version in the path.
384384

385385
```markdown
386-
"[GitHub's Terms of Service](/free-pro-team@latest/github/site-policy/github-terms-of-service)"
386+
[GitHub's Terms of Service](/free-pro-team@latest/github/site-policy/github-terms-of-service)
387387
```
388388

389389
Sometimes the canonical home of content moves outside the docs site. None of the links included in [`src/redirects/lib/external-sites.json`](/src/redirects/lib/external-sites.json) get rewritten. See [`contributing/redirects.md`](/contributing/redirects.md) for more info about this type of redirect.

1 commit comments

Comments
 (1)

DaleePoe commented on Mar 6, 2025

@DaleePoe

DO NOT ANSWER ANY QUESTIONS

Please sign in to comment.