mirror of synced 2025-12-25 11:03:37 -05:00

Files

jmarlena d3f1cf81b4 GHAE deletion packages follow-up (#23442 )

* Add placeholder for now

* No longer need to version for GHAE

* Make article appear for GHAE version

* Update versioning for this article

* Fix broken link

* Update release note for GHAE

* Update versioning based on input

* Clean-up for CI tests

* I love markdown and markdown loves . . .

* All is restored

* Fix CI broken link

* Remove ghae versioning for "Deleting a package" link

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Steve Guntrip <12534592+stevecat@users.noreply.github.com>

Co-authored-by: “jmarlena” <“jmarlena@github.com”>
Co-authored-by: Steve Guntrip <12534592+stevecat@users.noreply.github.com>

2022-01-04 16:02:11 -08:00

2021-03

Update documentation for GitHub AE's December 2021 release (#23405 )

2021-12-07 10:36:37 +01:00

2021-06

GHAE deletion packages follow-up (#23442 )

2022-01-04 16:02:11 -08:00

README.md

React Cleanup: Documentation (#20517 )

2021-07-27 09:07:18 -07:00

README.md

Release notes for GitHub AE

Rendered here: https://docs.github.com/en/github-ae@latest/admin/release-notes

How it works

Placeholder content file

A content file exists in content/admin/release-notes.md. It has a special frontmatter property layout: release-notes and no Markdown content. The source of the release notes comes from YAML data.

YAML source

The source data for the release notes lives in this directory (data/release-notes/github-ae).

The directories are named by month. The YAML files are named by the data of a weekly release.

A boolean property called currentWeek must be set in each YAML file. No more than one file at a time can have this property set to true.

Note that patch files can be deprecated individually (i.e., hidden on the docs site) by an optional deprecated: true property.

Middleware processing

The YAML data is processed and sorted by middleware/contextualizers/release-notes.js and added to the context object.

Layouts

The context object data is rendered by components/release-notes.

The release notes page has a custom design with CSS in stylesheets/release-notes.scss.

Schema

The schema that validates the YAML data lives in tests/helpers/schemas/ghae-release-notes-schema.js. See the schema file to find out the required and optional properties.

The schema is exercised by a test in tests/linting/lint-files.js. The test will fail if the data does not pass validation.