1
0
mirror of synced 2025-12-20 18:36:31 -05:00
Commit Graph

64 Commits

Author SHA1 Message Date
Rachael Sewell
7398c30364 remove 2.21 markup (#20954) 2021-08-19 18:18:00 +00:00
hubwriter
2d99aee37a Use plural variables consistently (#20412)
* Use plural variables consistently

* Update content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md
2021-07-20 16:09:40 +00:00
Rachael Sewell
52cf583bdd add short titles to frontmatter (#20131) 2021-06-24 11:02:53 -07:00
Octomerger Bot
bf2c75b648 Branch was updated using the 'autoupdate branch' Actions workflow. 2021-06-25 00:50:52 +10:00
Sarah Schneider
cb12455649 ran script/content-migrations/use-short-versions.js 2021-06-24 10:21:07 -04:00
wolfy1339
b1d853f46e fix(webhooks): add withdrawn action to security_advisory event
Fixes #6073
2021-06-23 14:49:27 -04:00
Grace Park
6f7e4f50dc updating content files 2021-06-14 12:06:52 -07:00
Sarah Schneider
083002e829 fix liquid version conditionals 2021-06-10 17:26:14 -04:00
Sarah Schneider
f7e848e0c4 ran script/content-migrations/remove-map-topics.js && script/content-migrations/update-tocs.js 2021-05-19 10:12:38 -04:00
Racc
51ee705957 Fix example code snippets (#6209)
* Fix example code snippet

The `payload` parameter doesn't exist as the payload is being sent in the request body.

* Fix first snippet

* Add missing `request.body.rewind`

Co-authored-by: hubwriter <hubwriter@github.com>
2021-05-17 14:07:03 +00:00
Lucas Alves
df1ae6420c Updates REST API examples to HTTP/2 (#6002) 2021-05-06 21:30:50 +00:00
Rachael Sewell
a926da8b08 Update topics to sentence case (#19069) 2021-04-30 19:30:36 -07:00
Dirkjan Bussink
eb875d212e Remove the non standard Status header from example responses (#5791) 2021-04-29 10:50:01 -07:00
jmarlena
1fc4c3f68b Article restructuring for Sponsors landing page (#18772)
* Move article from github directory as a top-level product

* Update article titles

* Remove old -ing article titles

* Use older format for this PR

* Finish updating links for retitled articles

* Remove sponsors topic

* Add sponsors to index.md

* Create folder for map topic for sponsors

* Add integrating folder/category with super basic graphql article

* Add get started category/folder

* Update index.md

* Add articles to category folders and update all the links and check it out locally 🙏

* Fix space

* Fix set of broken links

* Update link in resuable

* Add the quickstart

* Add USD

* Add matching donations caveat

* fix ci failures

* Bringing back `-ing` to Sponsors titles, categories, & links (#18817)

* Bringing back -ing

* The one that got away

* Apply @ethanpalm's input

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

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

* Apply product input

* Apply suggestions from code review

Co-authored-by: Emily Gould <4822039+emilyistoofunky@users.noreply.github.com>

* Apply @emilyistoofunky's input

* Sponsors landing page design (#18774)

* Add sponsors to index.md as a top-level product

* Revamp the GitHub Sponsors landing page with article links

* remove merge tags

* add community section

* add sponsor descriptions

* swap repo for user

* remove prefix tag

* lint

* remove topic fix landing page

* Tweak articles on landing page

* Drop "account"

* Add quickstart

* Bigger, brighter, and shorter intro

* Possibly too long of an intro?

* fix quickstart link

* add guides page

* fix error for mismatch between title and filename

* use link over guid

* remove HTML from layout file (aligns to #18811)

* use variable for section title

* Add intro

* Remove beta

* Apply suggestions from code review

Co-authored-by: Emily Gould <4822039+emilyistoofunky@users.noreply.github.com>

* Apply suggestions from code review

* Integrate article changes and remove old TOC

* Fixing the commented out text to match other landing pages 👓

* Apply suggestions from code review

Co-authored-by: Emily Gould <4822039+emilyistoofunky@users.noreply.github.com>

* Switch up order of sidebar categories

* Add new text to landing page button

* Add topics and types

* Add the underscore

* Add some more topics

* fix `type:`

* Fix topics

* plural ftw

* hide learning paths when not defined

* lint

* Add quickstart to guides page

* remove unused sidebar links

* hide subsection title when learning tracks are not present

* Apply @emilyistoofunky's topics input

* Remove duplicated topics

* Events ftw

* typo

* Remove obsolete topics for now

* add some temporary duplicate topics

* Resolve Linter error

Co-authored-by: Rachael Sewell <rachmari@github.com>
Co-authored-by: Emily Gould <4822039+emilyistoofunky@users.noreply.github.com>

Co-authored-by: Rachael Sewell <rachmari@github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
Co-authored-by: Emily Gould <4822039+emilyistoofunky@users.noreply.github.com>
2021-04-21 11:48:19 -07:00
Rachael Sewell
8054606ad8 Webhook restructuring follow-up (#18872)
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
2021-04-21 03:11:35 +00:00
Octomerger Bot
5e9dbc48f8 Branch was updated using the 'autoupdate branch' Actions workflow. 2021-04-03 03:12:35 +10:00
lowlighter
3b57f18f8f Merge branch 'main' of https://github.com/lowlighter/docs into main 2021-04-02 13:18:16 +02:00
lowlighter
92a55f75dc Add missing line-break in PullRequestReviewEvent 2021-04-02 13:17:51 +02:00
Simon Lecoq
0b0756c8ef Merge branch 'main' into main 2021-04-02 13:10:19 +02:00
lowlighter
154884cd79 Add PullRequestReviewEvent documentation 2021-04-02 13:07:42 +02:00
mc
cfc0c6a85b added what could be the correct link (#18545) 2021-04-01 17:55:23 +01:00
Laura Coursen
3ae481ea7b Add webhook events for discussions (#18442) 2021-03-30 17:38:13 +00:00
Emily Gould
a06ea17a4b Make Building a strong community a top-level doc set (#18396)
* Move directory to new location

* Update new index page

* Create wikis category

* Create blocking category

* Create moderation category

* Make map topics into category indexes

* Create contributions category

* Create template category

* Add redirects

* Add new product to products.yml

* Rename product for URL purposes

* Update links to wiki content

* Update links to maintaining safety articles

* Update links to moderation content

* Remove old category from github product index

* Fix links

* Update links to healthy contributions articles

* Update links to template articles

* Fix links
2021-03-29 16:40:32 -05:00
hubwriter
dfa86061d9 Fix the webhook tutorial (#18411) 2021-03-26 08:42:05 +00:00
Pierre Grimaud
9bc331a662 docs: fix typos 2021-03-24 15:57:21 +01:00
hubwriter
76c866715c Apply changes from PR #4629 (#4780)
* Apply changes from PR 4629

We have a problem (discussed internally with engineering) preventing the Update branch button being displayed on PR 4629 - which prevents that PR from being merged.

* Add change from PR 4629

* Update content/actions/reference/events-that-trigger-workflows.md
2021-03-24 09:38:20 +00:00
Felicity Chapman
28bec608c7 Group user docs on code security into a new "product" - with more redirects (#18278) 2021-03-22 09:28:35 +00:00
Vivek-Hotti
84fdf589a6 Addition of pusher_type to create_properties and delete_properties webhooks (#4570)
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
2021-03-19 05:05:12 +00:00
Rachael Sewell
b1b8cb8e84 add topic frontmatter to articles (#18245) 2021-03-17 12:31:29 -07: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
Octomerger Bot
ea6adac97d Branch was updated using the 'autoupdate branch' Actions workflow. 2021-03-17 15:11:13 +10:00
Stéphane Brunner
0d0d3c02ba Add some missing properties on workflow_run events (#2767)
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
2021-03-17 14:47:37 +10:00
Felicity Chapman
024014740b Group user docs on code security into a new "product" (#18196) 2021-03-16 17:25:29 +00:00
David Staheli
436345792f Fix link to "Signature verification object"
The current link to "Signature verification object" uses a # anchor that doesn't exist any more.  This PR updates the link to point to the primary section that discusses "Signature verification object."
2021-03-02 15:39:06 +00: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
Natasha Umer
2df6837969 Update Sender Field For Code Scanning 2021-02-12 18:07:36 +00:00
Sarah Edwards
aefb091588 GitHub Apps "beta features" are now "optional features" (#17640)
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
2021-02-10 23:50:21 +00:00
Kristian
f61b9a7065 Add note to handle webhook payloads as UTF-8 (#3315)
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
2021-02-10 07:03:31 +00:00
Sarah Schneider
ef9b03a867 Merge branch 'main' of github.com:github/docs-internal into check-links-improvement-redux 2020-12-16 16:32:41 -05:00
usiegl00
5474b6d042 Update securing-your-webhooks.md (#1692)
The request header is `HTTP_X_HUB_SIGNATURE_256` not `HTTP_X_HUB_SIGNATURE_2`.
2020-12-16 17:05:03 +10:00
Anders Bjerner
5a81f4634e Tiny headline adjustment for the Issue event types page (#2004) 2020-12-16 14:11:41 +10:00
Ivan Žužak
da195a134e Remove wrongly added link in webhook events docs (#16962)
Fixes https://github.com/github/docs-internal/issues/14280. This was unintentionally added in https://github.com/github/internal-developer.github.com/pull/6352

Co-authored-by: Laura Coursen <lecoursen@github.com>
2020-12-15 17:03:56 +00:00
Sarah Schneider
624245dabe Merge branch 'main' of github.com:github/docs-internal into check-links-improvement-redux 2020-12-14 15:52:46 -05:00
Sarah Edwards
8e1455ebe1 Fix broken links (#16700)
* delete section describing use of oauth api in dotcom only section

* version mention of oauth api for ghae only

* version code scanning alert not for ghae

* version security alerts to not be for GHAE

* version Libraries article to include GHAE

* version links to beta and suspending apps to not be for GHAE or GHES

* version link to authorization API to be GHES only

Co-authored-by: Sarah Schneider <sarahs@github.com>
2020-12-10 10:28:12 -08:00
OscarDOM
d18940baab 'installation' property is always present for some payloads (#1948) 2020-12-10 11:22:54 +10:00
mc
8025d9216d Secret scanning webhooks & APIs (#16608)
Co-authored-by: shati-patel <shati-patel@github.com>
Co-authored-by: Grey Baker <greysteil@github.com>
Co-authored-by: Prashanth Kannan <prashkan@github.com>
Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>
Co-authored-by: Melanie Yarbrough <11952755+myarb@users.noreply.github.com>
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
2020-12-04 09:39:29 +10:00
Ivan Žužak
6dd1cb725c Repository.deleted events are not exclusive to org webhooks (#16719)
Fixes https://github.com/github/internal-developer.github.com/issues/2948 and fixes https://github.com/github/ecosystem-api/issues/1028

Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
2020-12-03 00:34:52 +00:00
Sarah Schneider
5752ea9445 update legacy alt-formatted links too 2020-11-24 14:15:45 -05:00
Sarah Schneider
0b6d024d25 ran the modified script/content-migrations/update-developer-site-links.js 2020-11-23 12:01:14 -05:00
Lucas Costi
6882f6b785 Apply correct GHES versioning to 'workflow improvement' features (#16512) 2020-11-19 14:04:05 +10:00