Skip to content

Commit b13d24e

Browse files
zekeJasonEtco
andauthored
update scripts/README.md (#117)
Co-authored-by: Jason Etcovitch <jasonetco@github.com>
1 parent b64632c commit b13d24e

File tree

1 file changed

+113
-11
lines changed

1 file changed

+113
-11
lines changed

script/README.md

Lines changed: 113 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,27 @@ Run this script in your branch to check whether any images referenced in Enterpr
8787
---
8888

8989

90+
### [`content-migrations/extended-markdown-tags.js`](content-migrations/extended-markdown-tags.js)
91+
92+
93+
94+
---
95+
96+
97+
### [`content-migrations/octicon-tag.js`](content-migrations/octicon-tag.js)
98+
99+
100+
101+
---
102+
103+
104+
### [`content-migrations/site-data-tag.js`](content-migrations/site-data-tag.js)
105+
106+
107+
108+
---
109+
110+
90111
### [`create-glossary-from-spreadsheet.js`](create-glossary-from-spreadsheet.js)
91112

92113
This script turns a Google Sheets CSV spreadsheet into a YAML file.
@@ -115,6 +136,19 @@ Pass this script any old dotcom path (e.g., `articles/foo` or `foo.md`) and it w
115136
---
116137

117138

139+
### [`get-new-version-path.js`](get-new-version-path.js)
140+
141+
Helper script that returns a "new" versioned path given an "old" versioned path.
142+
143+
Examples:
144+
145+
Given: /github/getting-started-with-github/using-github Returns: /free-pro-team@latest/github/getting-started-with-github/using-github
146+
147+
Given: /enterprise/admin/installation/upgrading-github-enterprise Returns: /enterprise-server@2.22/admin/installation/upgrading-github-enterprise
148+
149+
---
150+
151+
118152
### [`graphql/build-changelog-from-markdown.js`](graphql/build-changelog-from-markdown.js)
119153

120154

@@ -199,16 +233,67 @@ This script moves reusables out of YAML files into individual Markdown files.
199233
---
200234

201235

236+
### [`new-versioning/fixtures.js`](new-versioning/fixtures.js)
237+
238+
239+
240+
---
241+
242+
243+
### [`new-versioning/main`](new-versioning/main)
244+
245+
All the new versioning!
246+
247+
Usage $ script/new-versioning/main
248+
249+
---
250+
251+
252+
### [`new-versioning/move-admin-dir.js`](new-versioning/move-admin-dir.js)
253+
254+
255+
256+
---
257+
258+
259+
### [`new-versioning/update-content.js`](new-versioning/update-content.js)
260+
261+
262+
263+
---
264+
265+
266+
### [`new-versioning/update-frontmatter.js`](new-versioning/update-frontmatter.js)
267+
268+
269+
270+
---
271+
272+
273+
### [`new-versioning/update-products-yml.js`](new-versioning/update-products-yml.js)
274+
275+
276+
277+
---
278+
279+
202280
### [`pages-with-liquid-titles.js`](pages-with-liquid-titles.js)
203281

204282
This is a temporary script to visualize which pages have liquid (and conditionals) in their `title` frontmatter
205283

206284
---
207285

208286

209-
### [`prevent-pushes-to-master.js`](prevent-pushes-to-master.js)
287+
### [`ping-staging-apps.js`](ping-staging-apps.js)
210288

211-
This script is intended to be used as a git "prepush" hook. If the current branch is master, it will exit unsuccesfully and prevent the push.
289+
This script finds all Heroku staging apps and pings them to make sure they're always "warmed" and responsive to requests.
290+
291+
---
292+
293+
294+
### [`prevent-pushes-to-main.js`](prevent-pushes-to-main.js)
295+
296+
This script is intended to be used as a git "prepush" hook. If the current branch is main, it will exit unsuccesfully and prevent the push.
212297

213298
---
214299

@@ -220,6 +305,13 @@ This script is run as a git precommit hook (installed by husky after npm install
220305
---
221306

222307

308+
### [`preview-openapi-changes`](preview-openapi-changes)
309+
310+
311+
312+
---
313+
314+
223315
### [`purge-fastly`](purge-fastly)
224316

225317
Run this script to manually purge the [Fastly cache](https://github.com/github/docs-internal#fastly-cdn). Note this script requires a `FASTLY_SERVICE_ID` and `FASTLY_TOKEN` in your `.env` file.
@@ -234,26 +326,29 @@ Run this script to manually purge the [Fastly cache](https://github.com/github/d
234326
---
235327

236328

237-
### [`reconcile-filenames-with-ids.js`](reconcile-filenames-with-ids.js)
329+
### [`reconcile-category-dirs-with-ids.js`](reconcile-category-dirs-with-ids.js)
238330

239-
An automated test checks for discrepancies between filenames and [autogenerated heading IDs](https://www.npmjs.com/package/remark-autolink-headings). If the test fails, a human needs to run this script to update the filenames.
331+
An automated test checks for discrepancies between category directory names and slugified category titles as IDs.
332+
333+
If the test fails, a human needs to run this script to update the directory names and add appropriate redirects.
240334

241335
**This script is not currently supported on Windows.**
242336

243337
---
244338

245339

246-
### [`remove-deprecated-enterprise-version-markup.js`](remove-deprecated-enterprise-version-markup.js)
340+
### [`reconcile-filenames-with-ids.js`](reconcile-filenames-with-ids.js)
247341

248-
Run this script after an Enterprise deprecation to remove Liquid statements and frontmatter that contain the deprecated Enterprise version. See the Enterprise deprecation issue template for instructions.
342+
An automated test checks for discrepancies between filenames and [autogenerated heading IDs](https://www.npmjs.com/package/remark-autolink-headings). If the test fails, a human needs to run this script to update the filenames.
249343

250-
You can run this script on either the help docs or the developer docs. To run it on the help docs, enter:
344+
**This script is not currently supported on Windows.**
345+
346+
---
251347

252-
`script/remove-deprecated-enterprise-version-markup.js`
253348

254-
To run it on the developer docs, provide a path to your developer docs checkout as an argument. You can use a tilde to represent your home directory. For example:
349+
### [`remove-deprecated-enterprise-version-markup.js`](remove-deprecated-enterprise-version-markup.js)
255350

256-
`script/remove-deprecated-enterprise-version-markup.js ~/Desktop/internal-developer.github.com/`
351+
Run this script after an Enterprise deprecation to remove Liquid statements and frontmatter that contain the deprecated Enterprise version. See the Enterprise deprecation issue template for instructions.
257352

258353
---
259354

@@ -310,7 +405,7 @@ Run this script to standardize frontmatter fields in all content files, per the
310405

311406
### [`sync-algolia-search-indices.js`](sync-algolia-search-indices.js)
312407

313-
This script is run automatically via GitHub Actions on every push to `master` to generate searchable data and upload it to our Algolia account. It can also be run manually. For more info see [search.md](../search.md)
408+
This script is run automatically via GitHub Actions on every push to `master` to generate searchable data and upload it to our Algolia account. It can also be run manually. For more info see [contributing/search.md](contributing/search.md)
314409

315410
---
316411

@@ -351,6 +446,13 @@ This script is used by other scripts to update temporary AWS credentials and aut
351446
---
352447

353448

449+
### [`update-versioning-in-files.js`](update-versioning-in-files.js)
450+
451+
452+
453+
---
454+
455+
354456
### [`upload-enterprise-images-to-s3.js`](upload-enterprise-images-to-s3.js)
355457

356458
Run this script to: [upload individual files to S3](https://github.com/github/product-documentation/blob/master/doc-team-workflows/workflow-information-for-all-writers/adding-individual-images-to-earlier-verisons-of-enterprise.md) or: [upload a batch of files to S3 for a new Enterprise release](https://github.com/github/product-documentation/blob/master/doc-team-workflows/working-on-enterprise-releases/information-for-all-writers/storing-a-batch-of-assets-on-s3-for-a-new-release.md). Run `upload-enterprise-images-to-s3.js --help` for usage details.

0 commit comments

Comments
 (0)