jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-21 10:57:10 -05:00
Code Issues Projects Releases Wiki Activity
13,110 Commits 28 Branches 1 Tag
0a9fa743578b49b98fcc8c0135190cb15e78d82c
Commit Graph

519 Commits

Author SHA1 Message Date
Rachael Sewell
02ee72fa25 add topics attribute to search (#18212) 2021-03-17 13:11:29 -07:00
Sarah Schneider
5006cdaff2 add tests 2021-03-17 10:30:16 -04:00
Felicity Chapman
6a7e93f225 Revert "Group user docs on code security into a new "product" (#18196)" (#18277) 2021-03-17 08:07:11 +00:00
Felicity Chapman
024014740b Group user docs on code security into a new "product" (#18196) 2021-03-16 17:25:29 +00:00
Sarah Schneider
3c1a49e626 Merge branch 'main' into graphql-explorer-query-params 2021-03-12 10:35:13 -05:00
James M. Greene
9e31597ee4 Use promisified fs.readFile instead of fs.promises.readFile (#18204) 
* Create a readFileAsync wrapper module

* Use the readFileAsync wrapper module instead of fs.promises.readFile

* Fix require path in test
 2021-03-10 17:57:10 +00:00
Emily Gould
052a540cdb Getting started category landing page (#17841) 
* Start building out landing page in index file

* Add articles

* Add a couple more popular articles

* Tweak intro to cover more audiences

* Add TOC back with new organization

* Update content/github/getting-started-with-github/index.md

* Category as product guides section

* Update breadcrumbs.js

* Update server.js

* Update product-landing.html

* Remove TOC listing

* Revert removing TOC

* Update index.md

* Update index.md

* Update content/github/getting-started-with-github/index.md

* Apply suggestions from code review

Co-authored-by: Laura Coursen <lecoursen@github.com>

Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
Co-authored-by: Laura Coursen <lecoursen@github.com>
 2021-03-09 10:04:45 -06:00
Sarah Schneider
4547221c1a Merge branch 'main' of github.com:github/docs-internal into graphql-explorer-query-params 2021-03-04 13:48:26 -05:00
Sarah Schneider
bc5e576e38 Merge branch 'main' of github.com:github/docs-internal into github-ae-release-notes 2021-03-04 13:45:48 -05:00
Sarah Schneider
225bf25220 Merge branch 'main' into ghes-latest-redirect 2021-03-02 09:41:50 -05:00
Sarah Schneider
d9d9834194 add basic test 2021-03-01 19:18:39 -05:00
Sarah Schneider
284cfeda4b rename test file 2021-03-01 17:04:27 -05:00
Matt Pollard
2db9da5c8f [DO NOT MERGE] GitHub AE consumables beta megabranch (#17620) 
* Empty commit

* updated beta note for GHAE

* more GHAE update + resolve conflict

* more GHAE updates + prepare for screenshots

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* address remaining review comments

* Revise "About GitHub AE" (#17679)

* add screenshots to the Configuring article

* reworked to have a separate GHAE section

* list numbering

* more work on screenshots and conditions

* add GHAE screenshots in article

* review screenshots in article

* added more screenshots and updated more articles

* screenshot madness

* fix liquid versioning

* refactor the ghae script

* [GHAE CB/Feb 22]: Add article about data residency for GitHub AE (#17847)

* add missing GHAE versioning to article

* move screenshots to GHAE asset directory

* forgot to change the path for these two images

* replace CBB screenshot + add better screenshot

* [GHAE CB/Feb 22]: Document upgrades for GitHub AE (#17848)

* Version article for GitHub AE

* Replace unused variable

* Incorporate reviewer feedback

* Update intro

Co-authored-by: Ethan P <56270045+ethanpalm@users.noreply.github.com>

* [GHAE] Enable IP allow list (#17691)

* Notes for CC

* Updat permission leves chart

* Add updated article to further reading

* Update gated feature callout with GitHub AE

* Version "Managing allowed IP addresses for your organization" for AE

* Update images

* Update "Restricting network traffic to your enterprise" with new procedures

* remove todo note

* Update audited actions

* Update info about Premium Runners

* Use reusable for Premium Runners

* Change "Premium Runners" to "AE hosted runners"

* Incorporate reviewer feedback

* Use correct reusable

* Version reusable correctly

* [Feb 22] GHAE: Code scanning beta (#17830)

* Add "github-ae" to all the frontmatter

* GHAE-ify the reusables

* Add some more changes

* Re-use some content

* 🔪 Semmle links

* Revert change re "--external-repository-token" in the CodeQL runner

* Update CodeQL runner token scopes

* Update two screenshots

* Remove mention of GitHub.com from AE + other fixes

* Apply suggestions from code review

Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>

* Use `product_name` variable instead of `product_location`

* Remove confusing phrase

* [Feb 22] GHAE: Code scanning API and webhook docs (#17883)

* Version API and webhook docs

* Actually add versioning for GHAE

* Fix anchor

* [TEMPORARY] Preview for API endpoints

* Revert API previews

* Update procedure step

Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>

* Update docs for AzureAD Group SCIM support in GHAE (#17892)

* [GHAE CB] SMTP bootstrapping flow (#17888)

* draft

* update with AE conntent

* update with tons of versioning

* remove that  lie

* fill out the rest of these steps

* update with correct versioning

* more edits

* add images

* reversion most of ae article

* fix versioning

* format correctlly

* words matter

* last image

* update with permmissions

* update versioning

* add link

* apply feedback ❤️

* update with differrent spacing

* update with feedback

* more feedback

* Temporary GHAE release notes for consumables beta launch (#17859)

* Create release-notes.md

* Add frontmatter

* Add to index file

* Update github-ae-release-notes.md

* Add release notes from Google Doc

* Update finalized docs links that have been reviewed

* OAuth device flow link update

* version for AE

* few fixes

* Update content/admin/overview/github-ae-release-notes.md

* small edits

* whoops

* commit

* update with different links

* used wrong reusable

* fix more brokenness

* Update repository-references.js

* Update repository-references.js

Co-authored-by: Meg Bird <megbird@github.com>
Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>

* [GHAE] Audit public repos (#17917)

* verifying what we mean by public

* Apply suggestions from code review

* Update content/developers/apps/installing-github-apps.md

Co-authored-by: Laura Coursen <lecoursen@github.com>

* fixing placememnt of liquid conditional

Co-authored-by: Laura Coursen <lecoursen@github.com>

* GHAE packages beta (#17786)

Co-authored-by: jmarlena <6732600+jmarlena@users.noreply.github.com>
Co-authored-by: Martin Lopes <martin389@github.com>

* fix broken links

* [GHAE CB/March 01]: GitHub Actions on GHAE (beta) (#17725)

* Added initial layout for premium runners

* Restructured content

* Added placeholder for removing premium runner

* Added versioning and warning note for self-hosted runners

* Added versioning and beta notice for actions content

* Rephrased beta note

* Added versioning for API docs, fixes

* Added versioning fixes

* Split Github-hosted and premium topics into separate articles

* Added edits

* Restructured some topics

* Revised "Using premium runners in a workflow"

* Some small fixes

* Fixed typo

* Added fixes to reusable

* Added edits

* Made section titles consistent

* Added billing, group mgmt, reusable steps

* Cropped certain screenshots for future-proofing

* Removed superfluous reusable

* Added fixes

* Revert "Cropped certain screenshots for future-proofing"

This reverts commit c7f24f31fa30d4fe3de2b63fc3cd5feba44ef518.

* Added new section for custom images

* Added versioning for enterprise-admin operations

* Added edits

* Added edits

* Update adding-premium-runners.md

* Removed SHR screenshots. Intending to update them when UI is available.

* Update using-labels-with-premium-runners.md

* Added custom labels section

* Added preview of API docs changes

* Added versioning for ip allow list section

* Removed removal article

* Renamed premium runners to AE hosted runners

* Re-added added API preview

* Fixed links, updated software specs

* Revised "Software specifications" based on feedback

* Fixed typos

* Small fixes

* Added new article "Creating custom images"

* Moved "Creating custom images" link

* Apply suggestions from code review

Co-authored-by: ahdbilal <55514721+ahdbilal@users.noreply.github.com>

* Added update from review

* Added updates from tech review

* Apply suggestions from code review

Co-authored-by: ahdbilal <55514721+ahdbilal@users.noreply.github.com>

* Added updates from tech review

* Added updates from tech review

* Added updates from tech review

* Added updates from tech review

* Fixed reusable

* Added fixes

* Added update from tech review

* Removed the dereferenced OpenAPI schema files

* Added fixes

* Fixed links

* Fixed links

* Apply suggestions from code review

Co-authored-by: jmarlena <6732600+jmarlena@users.noreply.github.com>

* Added updates from peer review

* Removed sections that are not in beta

* Update viewing-your-github-actions-usage.md

* Update viewing-job-execution-time.md

* Update index.md

* Update about-github-hosted-runners.md

* Restored versioning to match GHES approach

* Fixed link

* Restored self-hosted runner reference to UI steps.

* Updated screenshots

* Updated screenshots and procedures

* Small edits to screenshots

* Added AE url info for SHR

* Removed superfluous versioning

* Update security-hardening-for-github-actions.md

* Update actions-shared.md

* Small edits

* Update usage-limits-billing-and-administration.md

* Update managing-complex-workflows.md

* Additional versioning

* Additional versioning

* version environments api and checkrun deployments for ghae (#17991)

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

* Update reviewing-the-audit-log-for-your-organization.md

* Added versioning for enterprise policy settings

* version configuring artifact retention for AE

* remove AE versioning for connecting to Marketplace

* Apply suggestions from code review

Co-authored-by: Joe Bourne <thejoebourneidentity@github.com>

* Update content/admin/github-actions/getting-started-with-github-actions-for-github-ae.md

Co-authored-by: Joe Bourne <thejoebourneidentity@github.com>

* rewording not public to private

* fixing liquid

* Fixed elseif entries

* Added expectations note

* Revised label management article for AE hosted runners

* Added enterprise-admin note for adding AE hosted runners

* Update enterprise-admin.md

* Update self-hosted-runner-security.md

* Versioned reusable for AE

* Empty commit for CI

Co-authored-by: ahdbilal <55514721+ahdbilal@users.noreply.github.com>
Co-authored-by: jmarlena <6732600+jmarlena@users.noreply.github.com>
Co-authored-by: skedwards88 <skedwards88@github.com>
Co-authored-by: Leona B. Campbell <3880403+runleonarun@users.noreply.github.com>
Co-authored-by: Joe Bourne <thejoebourneidentity@github.com>
Co-authored-by: runleonarun <runleonarun@github.com>

* Update OpenAPI Descriptions for GHAE

* Update content/admin/overview/github-ae-release-notes.md

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Co-authored-by: mchammer01 <42146119+mchammer01@users.noreply.github.com>
Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>
Co-authored-by: shati-patel <shati-patel@github.com>
Co-authored-by: Sarah Schneider <sarahs@github.com>
Co-authored-by: skedwards88 <skedwards88@github.com>
Co-authored-by: Sarah Schneider <sarahs@users.noreply.github.com>
Co-authored-by: Melanie Yarbrough <11952755+myarb@users.noreply.github.com>
Co-authored-by: Felicity Chapman <felicitymay@github.com>
Co-authored-by: Meg Bird <megbird@github.com>
Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
Co-authored-by: Leona B. Campbell <3880403+runleonarun@users.noreply.github.com>
Co-authored-by: Laura Coursen <lecoursen@github.com>
Co-authored-by: jmarlena <6732600+jmarlena@users.noreply.github.com>
Co-authored-by: Martin Lopes <martin389@github.com>
Co-authored-by: ahdbilal <55514721+ahdbilal@users.noreply.github.com>
Co-authored-by: Joe Bourne <thejoebourneidentity@github.com>
Co-authored-by: runleonarun <runleonarun@github.com>
Co-authored-by: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com>
 2021-03-01 16:07:02 -05:00
Sarah Schneider
d3617af76a add test 2021-02-26 13:23:55 -05:00
Sarah Schneider
9b33879b4d add browser test for Explorer query param handling 2021-02-26 09:30:30 -05:00
Sarah Schneider
a10c2387ca Merge branch 'main' of github.com:github/docs-internal into use-redirects-file-instead-of-stubbed-archived-redirects 2021-02-24 10:35:33 -05:00
Kevin Heis
bcd91a04c6 End survey stars AB test (#17907) 
Co-authored-by: Chiedo John <2156688+chiedo@users.noreply.github.com>
 2021-02-22 18:27:57 +00:00
Sarah Schneider
a28c7ac2a2 add test 2021-02-22 11:14:01 -05:00
Kevin Heis
46ccfc5d93 Run AB test on survey stars (#17861) 
* Run AB test on survey stars

* Update browser.js

* Use text stars instead of primer ones

* Update experiment.js
 2021-02-18 16:29:17 +00:00
Rachael Sewell
01e52046f0 migrate away from AWS S3 (#17669) 2021-02-12 10:25:45 -08:00
Kevin Heis
626bfa5918 Move the one performance metric in page to exit to avoid join (#17784) 2021-02-11 16:28:07 +00:00
Jason Etcovitch
e68e6a5185 Revert "Revert "Absorb @github-docs/frontmatter (#17783)" (#17793)" (#17799) 
* Revert "Revert "Absorb @github-docs/frontmatter (#17783)" (#17793)"

This reverts commit 11baf43eee.

* Move revalidator to depedencies
 2021-02-11 11:15:59 -05:00
Jason Etcovitch
11baf43eee Revert "Absorb @github-docs/frontmatter (#17783)" (#17793) 
This reverts commit 1e96c03489.
 2021-02-10 20:28:41 +00:00
Jason Etcovitch
1e96c03489 Absorb @github-docs/frontmatter (#17783) 2021-02-10 15:10:46 -05:00
Kevin Heis
1918d2ea14 Inline CSRF token in HTML (#17748) 
* Inline CSRF token

* Fix tests
 2021-02-09 22:08:24 +00:00
Jason Etcovitch
d98bb561c7 Honor Error.status(Code) in handle-errors middleware (#17768) 
* Honor error status codes in handle-errors

* Add a test
 2021-02-09 14:57:57 -05:00
Kevin Heis
207c536609 Add page_event_id to all successive events (#17738) 
* Add `page_event_id` to all successive events

* Update events.js

* Break out event inits into functions so they don't break each other

* Update events.js

* Update events.js

* Update events.js
 2021-02-09 15:40:27 +00:00
Vanessa Yuen
25ff6b94ff Translation tools to make our lives easier (#17712) 
* create script to fix easy-to-fix frontmatter errors in translation

* improve reset-translated-file.js: allow reverting to the same file from `main` branch

* fix release-notes as well

* also lints liquid in frontmatter
 2021-02-09 10:11:12 -05:00
Jason Etcovitch
39e0e0dda1 Use Liquidjs instead of Liquid (#16743) 
* Install liquidjs, uninstall liquid

* Comment a bunch of stuff out to get going

* Fix invalid includes

* Fix all includes (path => 'path')

* Get the homepage to render

* Do link-in-list kinda

* Revert "Fix all includes (path => 'path')"

This reverts commit d6fead646353aa5041d9229470a62a1d487456b9.

* Support non-dynamic partials

* Extract getTemplate helper

* Do remaining custom Liquid tags

* Fix some custom tag bugs

* Moar bugs

* Re-add link tag

* Cleaner diff

* Actually fix extended markdown tags

* Fully comment out version matchers

* Smaller diff

* Rely only on Liquid internals for conditionals

* Use new operators option in Liquid engine

* Fix link.js

* Don't need options

* Updoot to the right doot

* Fix some bugs

* Fix another bug

* Pass a test

* Fix the translate bits

* Adjust a test

* Fix another invalid Liquid bug

* Two more borked translations

* Found some more

* Don't need this change

* Revert "Don't need this change"

This reverts commit a916d619747f0492865a69c3e237c97c4d4e7fad.

* This should fix the broken links

* Missed one

* Revert "This should fix the broken links"

This reverts commit e6c2cc0d9055d958706260d57edbe293281c150e.

* Revert "Missed one"

This reverts commit bbe1f23baf16e020f6f7931589decb1afc75dfbd.

* Updoot liquidjs
 2021-02-08 12:58:51 -05:00
James M. Greene
a40ff31b4b Cache more assets both in browser + Fastly (#17663) 
* Cache archived asset JS/CSS for a day

* Don't waste time with ETag calculations

* Add a comment about the expiration length

* Cache images and fonts for a day

* Cache GraphQL data files for a week

* Set Fastly surrogate-key header on all responses

* Update test to account for new response header
 2021-02-03 22:16:54 +00:00
Rachael Sewell
fc430896cb add azure to content security policy (#17649) 2021-02-03 10:49:40 -08:00
James M. Greene
0e729d9a75 Cleanup the testing and old code related to Fastly headers (#17643) 2021-02-03 10:43:00 -06:00
James M. Greene
8f133cbf54 Disallow both Fastly AND the browser from caching HTML pages (#17641) 2021-02-02 21:37:41 +00:00
Jason Etcovitch
53d8e60959 Add a test for non-English rendering (#17593) 
* Throw in some code that should fail a test

* Remove read-frontmatter behavior

* Unskip the test that would catch this

* Remove the throw to pass the test
 2021-02-02 18:14:39 +00:00
Vanessa Yuen
a1d93a7619 Lint translation files (#17561) 
### Why:

A lot of content gets mistranslated, some common patterns are: frontmatter date and enums getting translated, liquid tags get translated or go missing during the translation process. These translation errors are tough to catch, especially when they often come in huge PRs. 

### What's being changed:

- Frontmatter is also getting linted against schema as part of `lint-files`
- When an environment variable `TEST_TRANSLATION` is passed,
   - `lint-files` will run its tests against all files that have been newly translated (by git-diffing between `translations` branch and `main` branch), and
   - results are outputted using a custom jest reporter. The output is formatted in a way that makes it easy to exclude the problematic translated files from being merged, and to share the errors with [localization support](https://github.com/github/localization-support/issues/489). 
- Run the implemented translation test as part of the existing `Node.js Tests - Translations` workflow
 2021-02-01 17:59:33 +01:00
Jason Etcovitch
8d4f3e65fe Move test & script utils out of /lib (#17517) 
* Remove an unused file

* Move authenticate-to-aws to scripts/utils

* Move crowdin-config to tests/utils

* Remove add-frontmatter-to-file

* Move find-unused-assets

* Move git-utils to script/utils

* Move lib/github to script/utils

* Revert "Remove an unused file"

This reverts commit cd93ad846a0354e957359f23124eb0724c9147cf.

* Move find-extraneous-translation-files to script/utils

* We already have tests/helpers

* Rename script/utils => helpers for consistency

* Forgot a path

* Fix path to crowdin-config

Co-authored-by: Chiedo John <2156688+chiedo@users.noreply.github.com>
 2021-01-29 10:30:51 -05:00
Vanessa Yuen
4038e9ca85 Add topic property and filter to guides page (#17328) 
Co-authored-by: Emily Gould <4822039+emilyistoofunky@users.noreply.github.com>
 2021-01-29 12:32:31 +00:00
Jason Etcovitch
4a761418a9 Add a test for the WIP language banner link change (#17480) 
* Add a test

* Try adding de

* Let's try all languages
 2021-01-26 20:06:58 -05:00
Jason Etcovitch
612ec766aa Add glossaries to lint-files tests (#17481) 
* Add glossariesDir to glob

* Actually make the test work

* Fix the (legitimate) failures
 2021-01-26 21:19:27 +00:00
Jason Etcovitch
40d604d3c9 Add test to check content files against liquid.parse (#17479) 
* Add the test

* Don't forget this require
 2021-01-26 20:59:19 +00:00
Jason Etcovitch
b4171bf0d5 Use AST parsing for lint file checking (#17471) 
* Add markdown parsing dependencies

* Use it for the link test

* Use ast tests for hard-coded language

* Dedupe visiting for links

* Add new mdast utils to check-deps exclusions
 2021-01-26 17:45:23 +00:00
Sarah Schneider
35e430c96d Merge branch 'main' into make-developer-redirects-static 2021-01-26 11:30:16 -05:00
mc
4996deb228 Merge branch 'main' into 3059-remove-send-from-author 2021-01-26 14:14:14 +00:00
Kevin Heis
99a85ff4ef Push query string when searching (#17417) 
* Push query string when searching

* Update search.js

* Fix browser test, remove querystring dependency (new shiny!)

* Remove language and version from visible URL

* Avoid casting event interface

* Update search.js

* Update browser.js
 2021-01-25 11:52:55 -08:00
Sarah Schneider
0dbfa96b65 add message to test output 2021-01-25 13:10:08 -05:00
Vanessa Yuen
9bc90cd932 Learning Track navigation banner (#17440) 
* add middleware to handle `learn` query param

* add exception to query-less cache key

* add querystring to learning track guides
 2021-01-25 16:57:32 +00:00
shati-patel
d63f25091a Try a new test article in server.js 2021-01-23 13:56:49 +00:00
shati-patel
eb7ce2b47b Merge branch 'main' into 3059-remove-send-from-author 2021-01-23 13:39:49 +00:00
shati-patel
ba2f1570f6 change from main 2021-01-23 13:37:51 +00:00
shati-patel
de0a8e2430 Update server.js 2021-01-23 13:34:05 +00:00