1
0
mirror of synced 2026-01-05 12:07:35 -05:00
Files
docs/data/reusables
mc 53f8234b4e Reducing noise from notifications for Dependabot/security alerts (#16088)
* first stab

* fix issues with liquid tags

* applied a few fixes and improvements

* rewrite options

* rewrite for GHES 2.21

* fix liquid versioning (again)

* I love liquid tags

* swap paragraphs for GHES 2.21

* add link to new article in 2 existing articles

* started major rework to avoid info duplication

* part of the reorg work

* starting the major reorg

* fix syntax

* rework Configuring notifications article

* reorganizing again

* more reorg

* add new reusable

* fix typo

* add correct variable

* link to correct article for GHES < 2.21

* Update content/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies.md

Co-authored-by: Alex Mullans <infin8x@github.com>

* Apply suggestions from code review

Co-authored-by: Felicity Chapman <felicitymay@github.com>

* Update data/reusables/notifications/vulnerable-dependency-notification-options-detailed.md

Co-authored-by: Maya Kaczorowski <15946341+mayakacz@users.noreply.github.com>

* fix typo reported in #16036

* address comments from code review

* yet another commit

* polishing

* Update content/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies.md

Co-authored-by: Maya Kaczorowski <15946341+mayakacz@users.noreply.github.com>

* use variables

* address more comments

* add condition to link as linked article is free-pro-team only

* fix condition

* remove reusable that had duplicated content

* remove incorrect info

* fix issue in GHES article

* added shortTitle

* Apply suggestions from code review

Co-authored-by: Maya Kaczorowski <15946341+mayakacz@users.noreply.github.com>

* reword for clarity

* add more detail

Co-authored-by: Alex Mullans <infin8x@github.com>
Co-authored-by: Felicity Chapman <felicitymay@github.com>
Co-authored-by: Maya Kaczorowski <15946341+mayakacz@users.noreply.github.com>
2020-10-23 11:40:38 +01:00
..
2020-09-27 14:10:11 +02:00
2020-09-27 14:10:11 +02:00
2020-09-27 14:10:11 +02:00

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