docs/data/reusables
jmarlena 0a4f3e7dab
Self-serve package deletion and restoration (#17695)
* New article title & reposition article

* Update links

* Remove "Deleting a container image" article

* Reusable shuffle

* Add GHES versioned article

* more context

* Revise main article

* Reminder of permissions

* Update some copy

* Add "deleting a package" to TOC

* Add versioning around links

* Update restore package procedure

* Update permissions statements

* Fix GHES link

* Apply suggestions from code review

Co-authored-by: Martin Lopes <martin389@github.com>

* Use "entire" language

* GraphQL nuance

* New intro + actions

* Fix GHES link

* Package deletion 2.0 follow up (#17855)

* Remove GHES 3.1 versioning

* 3.0 or less

* Revert "Remove GHES 3.1 versioning"

This reverts commit 9bbc0bd57c1c7ba23097f3f4b9a830c13941402c.

* Revert "3.0 or less"

This reverts commit dfd2f48e4a4da62c2594fbeaeb12eacda5afc6d4.

* Revert "Revert "Remove GHES 3.1 versioning""

This reverts commit ef90065eb2883041b15bd2d50f97e4f07cf04768.

* Ditch unnecessary package namespace references and rework permissions framing

* Add placeholder note so PR tests will pass

* Add versioning around package deletion mentions outside of main deletion articles

* Add placeholder around link so it will go live

* Add `audit_log` entries

* Apply suggestions from code review

Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>

* Apply Shati's suggestion

* Remove duplicate line

Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>

* Package deletion 2.0 last updates (#17880)

* Update versioning and placeholder note

* syntax improvement

* Note the 25 downloads caveat

* Add more headings

* Apply suggestions from code review

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Sarah Edwards <skedwards88@github.com>

* Apply suggestions from code review

* Apply suggestions from code review

* Packages REST API page (#17808)

* Add draft of packages REST page

* Add packages in TOC

* Rewrite Packages API introductory info

* Fix space

* Rewrite conceptual API intro content

* Revise this line

* Apply suggestions from code review

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Mark Phelps <markphelps@github.com>

* Add rewrite

* Add de dereferenced files

* Add the decorated files

* ALL of the decorated files

* Revert "ALL of the decorated files"

This reverts commit 38f13dcd75078f2eacb53dfd0b31c79737966656.

* Revert "Add the decorated files"

This reverts commit b0c8a2096c8b19e62404585f97298ab42822d3e5.

* Revert "Add de dereferenced files"

This reverts commit abd377c8eb804e9c69dffa9b0c01ec64fb500727.

* Commit the lib/rest/static files to preview changes on staging

* Revert "Commit the lib/rest/static files to preview changes on staging"

This reverts commit acb121ae9d8bd2e23b00ebb14848e7b83aeddf5b.

Co-authored-by: Mark Phelps <markphelps@github.com>

* Commit static files to preview endpoints on staging

* Update references to API support

* remove static rest api files

* ditch "as a user" for now

* Rearrange based on feedback

* Last tidbits

* Update OpenAPI Descriptions (#17893)

* Update OpenAPI Descriptions

* Add decorated OpenAPI schema files

* link fix

Co-authored-by: Martin Lopes <martin389@github.com>
Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>
Co-authored-by: Sarah Edwards <skedwards88@github.com>
Co-authored-by: Mark Phelps <markphelps@github.com>
Co-authored-by: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com>
2021-02-17 17:02:10 -08:00
..
accounts Add GitHub Classroom documentation (#16564) 2020-12-08 15:59:35 +01:00
actions Soften advice; link to monitoring map topic (#17851) 2021-02-16 13:00:24 -08:00
advanced-security Committer-based billing M2 (phase 2)-specific work (#17730) 2021-02-17 15:50:14 +00:00
apps GitHub Apps "beta features" are now "optional features" (#17640) 2021-02-10 23:50:21 +00:00
audit_log [DO NOT MERGE] Universe 2020 Day 1: December 8, 2020 (#16480) 2020-12-08 12:20:02 -05:00
branches GitHub AE (GHAE) (#16090) 2020-11-02 15:12:44 -06:00
classroom First responder bug fixes for 2021-01-15 (#17334) 2021-01-26 17:40:56 +00:00
cli GitHub AE (GHAE) (#16090) 2020-11-02 15:12:44 -06:00
code-scanning Preparation for the committer-based billing phase 2 work (#17656) 2021-02-04 15:08:58 +00:00
codespaces Update with creating a codespace in VS code procedural (#15936) 2020-10-12 12:49:09 -04:00
command_line Remove deprecated GHES versions from content and data (#15830) 2020-10-01 10:55:34 -04:00
commits Remove unused assets post-migration (#15824) 2020-10-01 09:31:07 -04:00
community More powerful interaction limits 💪🏻 (#16335) 2020-11-05 07:17:59 -06:00
dashboard Update all files to use `{% data %}` (#15253) 2020-09-29 16:01:04 -04:00
dependabot Fix ecosystem support table (#17829) 2021-02-13 06:43:45 +00:00
desktop Add "Prompts" menu choice 2021-02-09 17:13:31 -05:00
developer-site Update events-that-trigger-workflows.md (#17013) 2020-12-18 16:24:46 +00:00
discussions remove reusable (#16844) 2020-12-09 20:02:21 +00:00
dotcom_billing Metered billing overage changes for invoiced accounts (#16455) 2020-12-14 18:53:23 +00:00
education First responder bug fixes for 2021-01-15 (#17334) 2021-01-26 17:40:56 +00:00
enterprise GitHub AE (GHAE) (#16090) 2020-11-02 15:12:44 -06:00
enterprise-accounts migrate away from AWS S3 (#17669) 2021-02-12 10:25:45 -08:00
enterprise-managed GitHub AE (GHAE) (#16090) 2020-11-02 15:12:44 -06:00
enterprise_clustering Document features and changes for phase 2.5 of master/main transition (#15745) 2020-10-01 16:43:01 -07:00
enterprise_deprecation Hello git history spelunker! 2020-09-27 14:10:11 +02:00
enterprise_enterprise_support GitHub AE (GHAE) (#16090) 2020-11-02 15:12:44 -06:00
enterprise_installation Correct minimum specifications for GitHub Enterprise Server 2.22 and 3.0+ (#17498) 2021-02-02 12:39:51 +01:00
enterprise_management_console [DO NOT MERGE] GitHub Enterprise Server 3.0 release candidate megabranch (#16479) 2021-01-13 19:16:05 -08:00
enterprise_migrations Clarify that data is being prepared for import 2021-01-19 08:52:42 -05:00
enterprise_site_admin_settings [DO NOT MERGE] GitHub Enterprise Server 3.0 release candidate megabranch (#16479) 2021-01-13 19:16:05 -08:00
enterprise_user_management GitHub AE (GHAE) (#16090) 2020-11-02 15:12:44 -06:00
feature-preview Add feature preview for container registry (#16424) 2020-11-16 14:54:32 -08:00
files Change != "free-pro-team@latest" to enterpriseServerVersions contains currentVersion, actually (#16114) 2020-10-21 21:33:43 -07:00
gated-features Pull request auto-merge GA (#17612) 2021-02-04 14:14:30 -07:00
gist Make public projects boards and gists internal for AE (#17247) 2021-01-14 08:36:05 -06:00
git Update all files to use `{% data %}` (#15253) 2020-09-29 16:01:04 -04:00
github-actions ubuntu-latest migration is in progress (#17606) 2021-02-02 16:35:14 +00:00
github-ae GitHub AE (GHAE) (#16090) 2020-11-02 15:12:44 -06:00
github-connect Update all files to use `{% data %}` (#15253) 2020-09-29 16:01:04 -04:00
github-insights Check repository references (#16680) 2020-12-03 16:41:03 +00:00
gpg Update all files to use `{% data %}` (#15253) 2020-09-29 16:01:04 -04:00
identity-and-permissions Restructure identity and access management content for enterprise accounts (#15079) 2021-01-14 08:18:10 -06:00
interactions [Nov 4] Adds updates to Interaction Limits API (#16290) 2020-11-12 18:05:51 -08:00
issue-events ran the modified script/content-migrations/update-developer-site-links.js 2020-11-23 12:01:14 -05:00
large_files [DO NOT MERGE] GitHub Enterprise Server 3.0 release candidate megabranch (#16479) 2021-01-13 19:16:05 -08:00
linux Hello git history spelunker! 2020-09-27 14:10:11 +02:00
marketplace Marketplace badges UI refresh (#17522) 2021-01-28 12:46:04 +00:00
mobile [DO NOT MERGE] GitHub Enterprise Server 3.0 release candidate megabranch (#16479) 2021-01-13 19:16:05 -08:00
notifications Add authentication information to required information for setting up SMTP for AE (#16340) 2020-12-16 15:31:26 +00:00
notifications-v2 [GHAE] Correct information about public repositories in Core content about GitHub AE (#16304) 2020-11-20 13:01:43 +01:00
open-source Update all files to use `{% data %}` (#15253) 2020-09-29 16:01:04 -04:00
organizations Preparation for the committer-based billing phase 2 work (#17656) 2021-02-04 15:08:58 +00:00
package_registry Self-serve package deletion and restoration (#17695) 2021-02-17 17:02:10 -08:00
pages Bug fixes 🐛 2021-02-11 17:22:47 +00:00
policies Update all files to use `{% data %}` (#15253) 2020-09-29 16:01:04 -04:00
pre-release-program Tiny versioning fix for GitHub Apps 2021-02-12 11:06:23 +00:00
products Update all files to use `{% data %}` (#15253) 2020-09-29 16:01:04 -04:00
profile [GHAE] Correct information about public repositories in Core content about GitHub AE (#16304) 2020-11-20 13:01:43 +01:00
project-management Make public projects boards and gists internal for AE (#17247) 2021-01-14 08:36:05 -06:00
projects Remove deprecated GHES versions from content and data (#15830) 2020-10-01 10:55:34 -04:00
pull_requests Pull request auto-merge GA (#17612) 2021-02-04 14:14:30 -07:00
reminders Update data/reusables/reminders/scheduled-reminders-limitations.md 2021-02-09 11:06:47 +01:00
repositories migrate away from AWS S3 (#17669) 2021-02-12 10:25:45 -08:00
saml Clarify release phase of SCIM provisioning for enterprise accounts in conceptual content (#17536) 2021-01-28 13:24:32 +00:00
scim GitHub AE (GHAE) (#16090) 2020-11-02 15:12:44 -06:00
search [Universe] Discussions Public Beta (#16547) 2020-12-07 15:00:35 -07:00
secret-scanning [DO NOT MERGE] GitHub Enterprise Server 3.0 release candidate megabranch (#16479) 2021-01-13 19:16:05 -08:00
security [DO NOT MERGE] GitHub Enterprise Server 3.0 release candidate megabranch (#16479) 2021-01-13 19:16:05 -08:00
security-advisory Hello git history spelunker! 2020-09-27 14:10:11 +02:00
shortdesc Remove deprecated GHES versions from content and data (#15830) 2020-10-01 10:55:34 -04:00
sponsors Update docs to note that you can only edit the price on a draft tier 2021-02-11 10:23:38 +00:00
ssh Update add-ssh-key-to-ssh-agent.md 2020-11-04 21:04:48 +01:00
support Update support entitlements for GitHub AE customers (#17831) 2021-02-16 14:38:05 -05:00
time_date Hello git history spelunker! 2020-09-27 14:10:11 +02:00
two_fa Change != "free-pro-team@latest" to enterpriseServerVersions contains currentVersion, actually (#16114) 2020-10-21 21:33:43 -07:00
user-settings Marketplace "verified creator" flow (#17375) 2021-01-25 11:55:37 +01:00
user_settings GitHub Codespaces beta features (#17037) 2021-01-07 11:31:07 -07:00
webhooks [Feb 2] Automerge PR webhook changes (#17461) 2021-02-02 02:48:01 +00:00
README.md Hello git history spelunker! 2020-09-27 14:10:11 +02:00

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 %}.