cde40f4847
* Issue template stuff for creating megabranch * Fix placeholder YAML * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * Add release candidate banner * update search indexes * update search indexes * update search indexes * update search indexes * [GHES 3.2]: Remove final notes about machine man preview (GA) (#20939) * update search indexes * update search indexes * Add GHES versioning to "Managing your theme settings" (#20950) * update search indexes * [GHES 3.2]: Fix versioning for security alerts (#20761) * made a start * rework * move image to an enterprise 3.1 folder * forgot to commit * simplify reusable * update search indexes * update search indexes * update search indexes * Updated basic 3.2 REST fiels after package change These will be overwritten before release by the new description files when the 3.2 description is properly published * update search indexes * GHAE feature flag for `security alerts` custom notification option (#20979) * made a start * rework * move image to an enterprise 3.1 folder * forgot to commit * simplify reusable * add GHAE feature flag * remove spurious spaces I had added * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * Update versioning (#21121) Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> * update search indexes * Add the new service (#21060) * update search indexes * update search indexes * update search indexes * Fix parent category index versioning for security overview * update search indexes * [GHES 3.2] Add documentation for GHES Referrer Policy Admin setting (#20910) Co-authored-by: jmarlena <6732600+jmarlena@users.noreply.github.com> Co-authored-by: Jules Parker <19994093+jules-p@users.noreply.github.com> Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> * update search indexes * update search indexes * Update "Review hardware considerations" table (#21208) Performance improvements resulted in higher maximum job throughput and the new benchmarks need to be shared with current and potential customers. * update search indexes * Version new GHES 3.2 Actions tested performance (#21212) * update search indexes * Update "Review hardware considerations" table v2 Feedback from additional reviewers requires an update to the benchmarks previously merged. * update search indexes * update search indexes * [GHES 3.2] - Dependency Graph: Simplified enablement in GHES (GA) (#21078) * document UI button for dependency graph GHES 3.2 * update search indexes * Update getting-started-with-github-actions-for-github-enterprise-server.md * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * [GHES 3.2] Release candidate 1 release notes (#20799) Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> Co-authored-by: bwestover <bwestover@github.com> Co-authored-by: Martin Lopes <martin389@github.com> Co-authored-by: Laura Coursen <lecoursen@github.com> Co-authored-by: Grey Baker <greysteil@github.com> Co-authored-by: Bas van Schaik <5082246+sj@users.noreply.github.com> Co-authored-by: William Bartholomew <iamwillbar@github.com> * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * Update OpenAPI Descriptions for GHES 3.2 (#21377) Also contains a rollup of other unmerged OpenAPI changes Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com> Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> * update search indexes Co-authored-by: Rachael Sewell <rachmari@github.com> Co-authored-by: GitHub Actions <action@github.com> Co-authored-by: Docubot <67483024+docubot@users.noreply.github.com> Co-authored-by: Laura Coursen <lecoursen@github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> Co-authored-by: Felicity Chapman <felicitymay@github.com> Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> Co-authored-by: Matthias Wenz <matthiaswenz@github.com> Co-authored-by: jmarlena <6732600+jmarlena@users.noreply.github.com> Co-authored-by: Jules Parker <19994093+jules-p@users.noreply.github.com> Co-authored-by: Steve-Glass <84886334+Steve-Glass@users.noreply.github.com> Co-authored-by: Meg Bird <megbird@github.com> Co-authored-by: bwestover <bwestover@github.com> Co-authored-by: Martin Lopes <martin389@github.com> Co-authored-by: Grey Baker <greysteil@github.com> Co-authored-by: Bas van Schaik <5082246+sj@users.noreply.github.com> Co-authored-by: William Bartholomew <iamwillbar@github.com> Co-authored-by: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com> Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
REST
About this directory
lib/rest/index.jsis human-editable.lib/rest/static/*.jsonare generated by scripts.
Editable files
lib/rest/index.jsconsumes the static decorated schema files and exportscategories,operations, andoperationsEnabledForGitHubAppsused by the REST middleware contextualizer.
Static files
Generated by script/rest/update-files.js:
lib/rest/static/dereferenced- dereferenced OpenAPI schema file for each version of GitHublib/rest/static/decorated- files generated from the dereferenced OpenAPI schema with the Markdown descriptions rendered in HTML
Rendering docs
When the server starts, middleware/contextualizers/rest.js accesses the data exported from the static decorated JSON files, fetches the data for the current version and requested path, and adds it to the context object. The added property is:
req.context.currentRestOperations- all operations with a category matching the current path
Markdown files in content/rest/reference use Liquid to loop over these context properties. The Liquid calls HTML files in the includes directory to do most of the rendering. Writers can add content to the Markdown files alongside the Liquid.