docs/data/reusables
Shweta ed12d3b3f1
Changes for improving Applying to GitHub Global Campus (#31671)
Co-authored-by: github-actions <github-actions@github.com>
Co-authored-by: Sarita Iyer <saritai@github.com>
2022-10-14 19:14:38 +00:00
..
accounts
actions Fix typo 2022-10-14 10:14:37 +02:00
advanced-security [2022-10-07]: Security Features Enablement Enterprise-Level Policies - [GA] (#31406) 2022-10-07 20:39:32 +00:00
advisory-database
apps Improve GitHub app permissions page terminology (#31415) 2022-10-04 23:28:24 +00:00
audit_log Support GHAE internal-only semantic versioning (#29178) 2022-09-22 08:26:58 +02:00
billing Reworked billing section 2022-08-31 17:32:23 +10:00
branches
classroom [Sep 15 2022] GitHub Classroom: support for LTI 1.3 and adding back info on connecting LMSes (#30704) 2022-10-14 18:33:42 +00:00
cli
code-scanning User request / Code Scanning / CodeQL: Better explain how to exclude paths for compiled languages (#28213) 2022-10-10 08:19:10 +00:00
codespaces Consolidating, clarifying & expanding the billing docs for Codespaces (#31521) 2022-10-13 11:15:49 +00:00
command-palette update keys according to guidelines and use proper keys 2022-10-01 14:50:41 +05:30
command_line Remove the emphasize tags and updated attributes style 2022-10-03 00:21:32 +05:30
commits
community
copilot Clarify limitations of code examples with duplication detection enabled (#30918) 2022-09-28 08:18:42 +02:00
dashboard
dependabot [2022-10-07]: Security Features Enablement Enterprise-Level Policies - [GA] (#31406) 2022-10-07 20:39:32 +00:00
dependency-review Dependency review action has shipped with GHES 3.6 and needs admin docs (#30291) 2022-09-02 16:28:50 +00:00
dependency-submission
desktop
developer-site
discussions
docs
dotcom_billing Consolidating, clarifying & expanding the billing docs for Codespaces (#31521) 2022-10-13 11:15:49 +00:00
education Changes for improving Applying to GitHub Global Campus (#31671) 2022-10-14 19:14:38 +00:00
enterprise
enterprise-accounts EMU emails are allowed to be duplicates of those in dotcom. (#31461) 2022-10-10 09:16:14 +00:00
enterprise-licensing
enterprise-managed
enterprise_backup_utilities Add a section about upgrading GitHub Enterprise Backup Utilities (#28250) 2022-09-08 09:49:17 +10:00
enterprise_clustering
enterprise_deprecation
enterprise_enterprise_support Bug fixes for Enterprise content, 2022-09-09 (#30644) 2022-09-12 13:45:05 +00:00
enterprise_installation Update Setting up a staging instance (#28292) 2022-10-12 11:42:10 +00:00
enterprise_management_console
enterprise_migrations Remove the emphasize tags and updated attributes style 2022-10-03 00:21:32 +05:30
enterprise_site_admin_settings Fix web commit signing docs to not require web-flow username (#30797) 2022-09-19 21:42:38 +00:00
enterprise_user_management Make product variables for APIs translation-friendly (#31465) 2022-10-07 14:52:51 +00:00
feature-preview
files
form-schema
gated-features Support GHAE internal-only semantic versioning (#29178) 2022-09-22 08:26:58 +02:00
gcm-core
getting-started [2022-10-07]: Security Features Enablement Enterprise-Level Policies - [GA] (#31406) 2022-10-07 20:39:32 +00:00
gist
git Remove the emphasize tags and updated attributes style 2022-10-03 00:21:32 +05:30
github-ae
github-connect
gpg Merge branch 'main' into patch-2 2022-10-11 13:13:23 -06:00
identity-and-permissions Removing all beta references. (#30311) 2022-10-07 18:01:13 +00:00
interactions
issue-events fix: add comment for assigner 2022-09-27 07:57:47 +08:00
large_files
linux
marketplace
mobile
notifications Edits to Notification Settings page following redesign (#30999) 2022-10-04 12:01:17 +00:00
notifications-v2 Toggle lightweight feature flags missed for the GitHub AE 3.3 release (#30659) 2022-09-14 07:20:46 +00:00
open-source
organizations [2022-09-30]: Allow org admins to disable app installation requests from outside collaborators (#31188) 2022-09-30 15:40:05 +00:00
package_registry Merge branch 'main' into codewithdev-changes 2022-10-03 00:29:29 +05:30
pages Merge branch 'main' into codewithdev-changes 2022-10-03 00:29:29 +05:30
policies
pre-release-program
products
profile Add instructions for setting location and time zone (#31481) 2022-10-11 18:20:31 +00:00
project-management
projects Merge branch 'main' into docs-correct-sprint-word 2022-09-26 15:18:39 +09:00
pull_requests add enqueued and dequeued actions to pull request webhook (#31289) 2022-09-30 20:41:56 +00:00
release-notes Consolidate, revise, and share known issue about hotpatch upgrades for GitHub Enterprise Server 3.3.14, 3.4.9, 3.5.6, and 3.6.2 (#31189) 2022-09-27 15:15:04 +00:00
releases
reminders
repositories Add "Best practice" article for writing security advisories (#31414) 2022-10-14 08:25:36 +00:00
rest-api
saml Bug fixes for Enterprise content, 2022-09-29 (#31278) 2022-10-06 14:38:19 +00:00
scim
search
secret-scanning [2022-10-07]: Security Features Enablement Enterprise-Level Policies - [GA] (#31406) 2022-10-07 20:39:32 +00:00
security
security-advisory
security-overview Support GHAE internal-only semantic versioning (#29178) 2022-09-22 08:26:58 +02:00
server-statistics
shortdesc
sponsors [October 3, 2022]: Removing Sponsors custom amount opt-out settings for maintainers (#31364) 2022-10-03 16:39:33 +00:00
ssh
stars
support Make product variables for APIs translation-friendly (#31465) 2022-10-07 14:52:51 +00:00
supported-languages
time_date
two_fa
user-settings Support GHAE internal-only semantic versioning (#29178) 2022-09-22 08:26:58 +02:00
vs-code Update data/reusables/vs-code/open-command-palette.md 2022-09-12 10:09:31 +02:00
webhooks Fix a broken link to the `dependabot_alert` webhook documentation (#31508) 2022-10-06 21:34:58 +00:00
README.md

README.md

Reusables

Reusables are long strings of reusable text.

Reusables are longer strings like paragraphs or procedural lists that can be referenced in multiple content files. Using Markdown (instead of YAML) makes it possible for our localization pipeline to split the strings into smaller translatable segments, leading to fewer translation errors and less churn when the source English content changes.

Each reusable lives in its own Markdown file.

The path and filename of each Markdown file determines what its path will be in the data object.

For example, a file named /data/reusables/foo/bar.md will be accessible as {% data reusables.foo.bar %} in pages.

Reusable files are divided generally into directories by task. For example, if you're creating a reusable string for articles about GitHub notifications, you'd add it in the directory data/reusables/notifications/ in a file named data/reusables/notifications/your-reusable-name.md. The content reference you'd add to the source would look like {% data reusables.notifications.your-reusable-name %}.

Versioning

Reusables can include Liquid conditionals to conditionally render content depending on the current version being viewed. See contributing/liquid-helpers.md.