1
0
mirror of synced 2026-01-04 09:06:46 -05:00
Commit Graph

335 Commits

Author SHA1 Message Date
Laura Coursen
7872d6da1e Clarify the relationship between OAuth/GitHub Apps and SAML/SCIM (#26940) 2022-04-22 15:51:57 +00:00
Rachael Sewell
6d2211cf25 Update index.md (#27103) 2022-04-21 04:06:29 +00:00
Grace Park
b98c83e924 REST operations sidebar (#26225)
* testing out a rest operations sidebar

* cleanup

* renamed 5 files

* renamed 5 files

* set redirect_from on 5 files

* renamed 1 files

* renamed 1 files

* renamed 3 files

* renamed 1 files

* renamed 1 files

* renamed 3 files

* renamed 1 files

* renamed 2 files

* renamed 1 files

* renamed 4 files

* renamed 15 files

* renamed 2 files

* renamed 6 files

* renamed 1 files

* renamed 4 files

* renamed 7 files

* renamed 1 files

* renamed 3 files

* renamed 3 files

* renamed 1 files

* renamed 5 files

* renamed 1 files

* renamed 1 files

* renamed 3 files

* renamed 4 files

* renamed 1 files

* renamed 1 files

* renamed 2 files

* renamed 4 files

* renamed 1 files

* renamed 1 files

* renamed 1 files

* renamed 6 files

* renamed 6 files

* renamed 4 files

* move files

* adding more

* updating to add restcontext and start of removing data/reusables/rest-reference

* removed data/reusables

* add a RestMiniTocItem and updating the filtering to add a subcategory so all manually added H3s are in mini tocs in addition to operations

* remove console log

* [WIP]: REST New Proposal Sidebar (#26471)

* saving

* update sidebar

* remove console log

* update guides and overview

* import Category for category level rest pages

* update undefined restOperations

* update restOperationData category and subcategory levels"

* minor updates

* update get mini toc items function

* updating REST context for sidebar

* updating rest data

* remove console logs

* WIP: mini-toc-ing the sidebar

Co-authored-by: Robert Sese <rsese@github.com>

* A little cleanup

* Fix first subcategory link and add some comments

* updating anchor links in sidebar

* adding updates

* remove standalone

* update product and maptopic pages using article context

* add conditional link wrapper

* fix sidebar toggle and versions for enterprise admin

* update versions per subcategory

* Highlight sidebar link for current page

* Update miniToc hash links and hash change tracking

* fix unique key in CollapsibleSection

* Fix list markup

* remove title

* update permissions

* Hide minitocs on landing (#26594)

* hide minitocs on landing page

* simplify page components and remove minitoc from sidebar for guides/overview

* fix carats and category fix

* remove id

Co-authored-by: Grace Park <gracepark@github.com>

* updating content based on versions script check with the OpenAPI

* update script and content files

* update script and content/rest files

* update to add TocLanding

* update script

* update index files

* add codespaces repository-secrets

* remove openapi schema check script

* remove minitocs at the top

* add h2 about the {title} api

* fix tests/unit/openapi-schema.js

* Fix linting tests

* fix search/topics test

* fix tests/unit/pages test

* update rest/reference links in components

* run prettier

* Update components/rest/RestReferencePage.tsx

Co-authored-by: Rachael Sewell <rachmari@github.com>

* Update components/rest/RestReferencePage.tsx

Co-authored-by: Rachael Sewell <rachmari@github.com>

* Update pages/[versionId]/rest/[category]/[subcategory].tsx

Co-authored-by: Rachael Sewell <rachmari@github.com>

* Update pages/[versionId]/rest/[category]/[subcategory].tsx

Co-authored-by: Rachael Sewell <rachmari@github.com>

* Update pages/[versionId]/rest/[category]/[subcategory].tsx

Co-authored-by: Rachael Sewell <rachmari@github.com>

* Update pages/[versionId]/rest/[category]/[subcategory].tsx

Co-authored-by: Rachael Sewell <rachmari@github.com>

* Update tests/unit/openapi-schema.js

Co-authored-by: Rachael Sewell <rachmari@github.com>

* updating comment location

* remove dependabot override

* remove path-utils current product update for rest

* run linter

* remove dependabot.md and remove h2 heading on restreference

* update the correct product to rest for rest pages

* adding comments for updates to path-utils

* remove console log

* REST sidebar: handle legacy v3 redirects (#26686)

* Add script to handle legacy v3 REST redirects

* Run the script

* Handle a redirect to a redirect

* Update REST test URLs

* 'await' and test runs subcategory of checks

* Update REST URLs for routing/developer-site-redirects tests

* Update developer-redirects fixture with new REST URLs

* Resolve merge conflicts

* Update rest-redirects fixture with new REST URLs

* Fix broken links with REST pages re-org

* redirectTo could be undefined

* Fix script for posterity, can't redirect paths with hashes

* Remove invalid hash redirects

* Typically don't need to save one-off scripts

* Undo redirect changes (not necessary for handling v3 redirects)

* Remove script-added redirects

* Update old v3 redirects with new REST URLs

* No more GHES search indexing page

* 'org' not 'organization'

* Update fixture data for new REST URLs

* revert any content directory changes

Co-authored-by: Grace Park <gracepark@github.com>
Co-authored-by: Rachael Sewell <rachmari@github.com>

* Adding test rest (#26750)

* add test to check openapi schema versions and content rest frontmatter versions

* update lib/redirects

* fix test and add error messages

* adding repository secrets

* adding repository-secrets.md

* Revert "update lib/redirects"

This reverts commit 3aafe28265764d5bc09c0c478c8e0ca099c8fbcf.

* remove lib/redirects changes and console logs

* Update lib/rest/index.js

Co-authored-by: Rachael Sewell <rachmari@github.com>

* update unique key

* Rest client side redirects (#26754)

* adding tags subcategory for the rest content repos category

* run prettier

* bug fix for anchor scrolls" (#26892)

* updating width size for rest reference page

* Rest sidebar consolidation (#26862)

* refactor sidebar

* fix articlecontext provider issue on rest product landing page for all versions

* fix a bug, create new component

* revert change to create new component and fix bug

Co-authored-by: Rachael Sewell <rachmari@github.com>

* Set currentAnchor with a hashchange handler (#26923)

* Rest sidebar design tweaks (#26807)

* Rest sidebar design tweaks

* tweak color to subtle

* use muted color and margin for line

* update to design feedback

Co-authored-by: Grace Park <gracepark@github.com>

* Remove cheerio from rest-collapsible (#26948)

* remove cheerio from rest-collapsible

* update type

* adding endswith instead

* use productId instead

* one off edge case for secret-scanning

* Reorganize subcategory and category, Update pre -> div, Add RestContext (#26950)

* reorganize subcategory and category

* add RestContext

* update comment

* update for endpoints page

* add comment

* move object to restcontext

* remove effectiveDate in restcontext

* remove width calculation for rest reference page

* fix adding manual writer's minitocs to sidebar

* update with feedback

* update comment

* update isRestReferencePage

* remove page component and fix bug

* adding back rest/index.tsx

Co-authored-by: Rachael Sewell <rachmari@github.com>

* update content/rest"

* add back design tweak

* update to div

* update margins on rest api reference

* remove page component

* adding tests

* separate product from rest sidebar (#27065)

* separate product from rest sidebar

* Use ProductCollapsibleSections for product pages

* fix tests

Co-authored-by: Robert Sese <rsese@github.com>
Co-authored-by: Grace Park <gracepark@github.com>

* Rest sidebar translations (#27052)

* update translations

* remove general test

Co-authored-by: Robert Sese <rsese@github.com>
Co-authored-by: Rachael Sewell <rachmari@github.com>
2022-04-20 10:19:48 -07:00
Sarah Edwards
345a950ad5 API preview follow up (#26914) 2022-04-19 20:06:18 +00:00
Matt Pollard
c999ebfe11 Remove fpt versioning for secret scanning REST API reference article (#26869) 2022-04-19 08:34:06 +00:00
Joshua Miller
0e30279443 📝 add note about future SDK team (#17072) 2022-04-18 16:09:47 +00:00
Sophie
ac4c64b683 Merge branch 'main' into sophie-6156-content 2022-04-13 09:14:13 +02:00
Debbie Milburn
d0efbf239d Update permissions-required-for-github-apps.md (#26537) 2022-04-12 17:58:14 +00:00
Josh Soref
158111374f Warn re:status for official octokit libraries (#16718) 2022-04-06 18:17:47 +00:00
Sarita Iyer
32542d3833 Merge branch 'main' into saritai/dependency-review-api-and-action 2022-04-06 11:14:17 -04:00
Matt Pollard
30f2b92798 Merge branch 'main' into sophie-6156-content 2022-04-06 13:53:40 +02:00
Sarah Edwards
3dcef750f0 version previews (#26571) 2022-03-31 16:42:04 +00:00
Sarita Iyer
b7257cebe0 Merge branch 'main' into saritai/dependency-review-api-and-action 2022-03-30 14:22:01 -04:00
Ramya Parimi
c7ac337a22 Merge branch 'main' into patch-2 2022-03-30 10:42:44 -05:00
Matt Gauger
682aab83a5 Fix reference to where data comes from on pulls.md 2022-03-25 15:31:02 -05:00
Gijs van Dam
6947c0964c Add -I parameter to curl command
When checking the rate limit while using your app's client ID and secret, you need to supply the `-I` argument to show the header of the response, containing `x-ratelimit-limit` and `x-ratelimit-remaining`
2022-03-25 11:35:59 +08:00
Sarita Iyer
20613aaf77 added Dependency graph page and info on action 2022-03-23 16:38:33 -04:00
Sarita Iyer
9d213a53e5 initial REST update for dependency review 2022-03-22 13:39:38 -04:00
Matt Pollard
6382d05d89 Merge branch 'main' into sophie-6156-content 2022-03-21 11:05:49 +01:00
Grace Park
2c8713037d Move deploy keys from deployments to keys in rest pages (#26166)
* move deploy keys from deployments to keys in rest pages

* move minitocs above intro

* Update content/rest/reference/keys.md

Co-authored-by: Sarah Edwards <skedwards88@github.com>

* add to banner, add redirects from deployments

* remove deploy keys from deployments intro

* update data/reusables name

* update - to _

* update script and add redirects for subcategories turned categories

Co-authored-by: Sarah Edwards <skedwards88@github.com>
2022-03-17 17:25:12 +00:00
Sophie
18edb677c9 Merge branch 'main' into sophie-6156-content 2022-03-17 09:25:19 +01:00
Sophie
74ba23bec7 Change instances of user account to personal account in content 2022-03-16 15:18:37 +01:00
Lucas Costi
cfba19d927 Add cache section for Actions REST API (#24924)
* Add cache section for Actions REST API

* Add permissions entries, cache section

* Add new cache directory after REST reactify changes

* Update content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md

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

* Add versioning for GHES/AE

Co-authored-by: Martin Lopes <martin389@github.com>
Co-authored-by: Felicity Chapman <felicitymay@github.com>
2022-03-16 10:37:19 +00:00
M Hickford
73226cf25b Replace localhost with 127.0.0.1 in OAuth examples 2022-03-08 14:20:57 +00:00
Robert Sese
79c48070c4 Deprecate 3.0 (#25646)
* Deprecate 3.0

* 3.0 deprecation: remove 3.0 markup (#25647)

* Remove liquid conditionals and content for 3.0 deprecation

* Remove manually, no longer versioned in a supported version

* Remove translations manually, no longer versioned in a supported version

* Remove 'if', now in all supported versions

* Remove dangling 'elseif', now in all supported versions

* Remove dangling 'elseif' and 3.0 screenshot reference, now in all supported versions

* Nudge to latest supported GHES version

* Nudge to latest supported release GHES version

* Bump all the version for the liquid tests

* Bump first deprecated version for linting tests

* Prefer double quotes

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

* Prefer double quotes

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

* Prefer double quotes

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

* Prefer double quotes

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

* Prefer double quotes

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

* Prefer double quotes

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

* Prefer double quotes

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

* Prefer double quotes

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

* Prefer double quotes

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

* Remove extra newline

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

* Remove extra newline

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

* Remove extra newline

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

* One reusable per line

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

* One reusable per line

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

* One reusable per line

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

* Version check not needed anymore

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

* Version check not needed anymore

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

* Version check not needed anymore

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

* Version check not needed anymore

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

* Version check not needed anymore

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

* Version check not needed anymore

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

* Version check not needed anymore

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

* Stray whitespace ✂️

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

* Stray whitespace ✂️

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

* Stray whitespace ✂️

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

* Stray whitespace ✂️

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

* Stray whitespace ✂️

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

* Stray whitespace ✂️

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

* Stray whitespace ✂️

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

* Stray whitespace ✂️

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

* Version check not needed anymore

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

* Version check not needed anymore

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

* Just 'ghes' since we're deprecating 3.0

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

* Just 'ghes' since we're deprecating 3.0

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

* Just 'ghes' since we're deprecating 3.0

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

* Just 'ghes' since we're deprecating 3.0

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

* Just 'ghes' since we're deprecating 3.0

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

* Just 'ghes' since we're deprecating 3.0

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

* Just 'ghes' since we're deprecating 3.0

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

* Just 'ghes' since we're deprecating 3.0

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

* Don't depend on hardcoded versions

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

* Remove static files for 3.0 deprecation (#25649)

Co-authored-by: Laura Coursen <lecoursen@github.com>
2022-03-03 13:08:24 -06:00
Felicity Chapman
705ea34184 [2022-03-03] Secret scanning: public repo scans for GHAS (#25667) 2022-03-03 18:40:57 +00:00
Peter Bengtsson
693fb35bc6 links on /rest/overview/endpoints (#25771)
* links on /rest/overview/endpoints-available-for-github-apps

* tests

* remove unused code
2022-03-03 17:45:37 +00:00
Rachael Sewell
2ade7d8489 reactify rest pages (#25005) 2022-02-28 18:30:54 +00:00
Steve Guntrip
d7b16de2b8 Fix app permissions for commit comment creation and reactions 2022-02-21 08:42:34 +00:00
Lucas Costi
e6af9ae1e6 Remove Actions REST enterprise subcategory (moved to Actions page) (#25065)
Co-authored-by: Rachael Sewell <rachmari@github.com>
2022-02-17 15:18:07 +10:00
George Brocklehurst
9861c1b617 [Feb 15, 2022] Document CODEOWNERS errors (#24861) 2022-02-16 13:36:59 +00:00
Vanessa
4b8b75e337 GitHub Enterprise Server 3.4 release candidate (#24754)
Co-authored-by: Laura Coursen <lecoursen@github.com>
Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
Co-authored-by: Vanessa <vgrl@github.com>
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
Co-authored-by: Lars Schneider <larsxschneider@github.com>
Co-authored-by: Jared Murrell <primetheus@github.com>
Co-authored-by: Jules Parker <19994093+jules-p@users.noreply.github.com>
Co-authored-by: Docubot <67483024+docubot@users.noreply.github.com>
Co-authored-by: Martin Lopes <martin389@github.com>
Co-authored-by: Laura Coursen <lecoursen@github.com>
Co-authored-by: Sarita Iyer <saritai@github.com>
Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com>
Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
Co-authored-by: hubwriter <hubwriter@github.com>
Co-authored-by: Steve Guntrip <stevecat@github.com>
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
Co-authored-by: Lars Schneider <larsxschneider@github.com>
Co-authored-by: Jared Murrell <primetheus@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>
2022-02-15 13:40:37 -05:00
Lucas Costi
3c4493c238 Fix REST Pages operations continuing the list from intro (#25358) 2022-02-15 12:02:46 +10:00
Vanessa
bee4549406 Add GHES 3.4 versioning to billing section in admin docset (#25163) 2022-02-09 15:18:27 +10:00
Vanessa
41ea422f86 Add GHES 3.4 versioning to REST API Billing article (#25159) 2022-02-09 14:15:41 +10:00
hubwriter
bd28f54b25 Add versioning for GHAE 3.3 (#24936) 2022-02-08 09:24:14 +00:00
Matt Pollard
c59d42e8aa Revert "Revert Add apps permissions for code scanning org endpoint (#25023)" (#25026) 2022-02-07 17:28:54 +00:00
Dasun Tharanga
5dbcc7ffcc The missing full stop was added. 2022-02-06 00:04:24 +05:30
Anders Starcke Henriksen
6a9296b880 Revert Add apps permissions for code scanning org endpoint (#25023) 2022-02-04 15:45:20 +00:00
Anders Starcke Henriksen
45cd56247a Add apps permissions for code scanning org endpoint. (#24859) 2022-02-04 14:05:51 +00:00
Matt Pollard
52f0a069a1 Bug fixes for Enterprise content, 2022-01-28 (#24798) 2022-02-03 11:29:07 +00:00
alpn
74e6dc4514 Set all x-ratelimit-* header names to loweracse
Currently x-ratelimit-* headers are in CamelCase (in the docs), but in practice the API returns them in lower case.
Although HTTP header names are (not case sensitive)[https://www.w3.org/Protocols/rfc2616/rfc2616.html],  this could still be confusing for some, therefor I propose to change it.
2022-02-01 08:32:02 -06:00
Rachael Sewell
ef4dee2e7d Revert "Revert "rest/reference/repos#statuses redirect"" (#24559) 2022-01-27 22:09:20 +00:00
Jason Lunz
f96b7ff6e0 Add github apps permissions for replica cache monitoring API (#24675) 2022-01-26 23:14:20 +00:00
Ramya Parimi
d27e09cc5b Fix vale errors in source (#24086)
* backticks for javascript

* Update sorting-search-results.md

backticks asc

* Update installing-github-enterprise-server-on-azure.md

fixed vm az

* Update searching-for-repositories.md

backticks

* Update searching-code.md

backticks

* Update searching-issues-and-pull-requests.md

backticks

* Update searching-issues-and-pull-requests.md

* Update understanding-the-search-syntax.md

* Update searching-for-packages.md

* Update upgrading-from-dependabotcom-to-github-native-dependabot.md

* fix errors in source

* removed spaces

* vale docs

* link to md link

* spacing for backticks

* docs draft

* remove space

* removed spacing

* drafting

* drafting

* draft

* escape single quote

* escape another single quote

* fix broken link

* vale guide

* edge case

* edge case ex

* edge case ex link

* grammer

* grammer

* Update vale-guide.md

clarity

* Update vale-guide.md

small edit

* clarity

* sentence fix

* Rubocop to RuboCop

* Rubocop -> RuboCop

* terms in backticks

* pem in backtick

* idp -> IdP

* file names in backticks

* public/private rsa in backticks

* fix vale errors

* fix vale errors

* Update sending-enterprise-contributions-to-your-githubcom-profile.md

fix dot-com links

* Update metadata-syntax-for-github-actions.md

* Update configuring-codeql-cli-in-your-ci-system.md

* Update content/get-started/getting-started-with-git/associating-text-editors-with-git.md

Co-authored-by: Vanessa <vgrl@github.com>

* Update managing-deploy-keys.md

public and private rsa key pair

* Update libraries.md

removed backticks for consistency

* Update sorting-search-results.md

removed backticks for consistency

* Update metadata-syntax-for-github-actions.md

removed backticks for consistency

* Update metadata-syntax-for-github-actions.md

removed backticks

* delete vale config files

Co-authored-by: Vanessa <vgrl@github.com>
Co-authored-by: Amy Burns <timeyoutakeit@github.com>
2022-01-25 11:18:19 -06:00
Matt Pollard
5af07647ef Centralize, update, and restructure some information about rate limits for REST API requests (#23685) 2022-01-25 15:04:24 +00:00
Rachael Sewell
91fbe1dd95 Revert "rest/reference/repos#statuses redirect (#24478)" (#24557) 2022-01-24 09:26:08 -08:00
Sarah Edwards
8228d02774 rest/reference/repos#statuses redirect (#24478) 2022-01-24 16:11:43 +00:00
SnowBit
320ec083c4 Removal of unwanted extra closure of achor tag 2022-01-19 10:35:32 +05:30
Laura Coursen
5fa130f751 @lecoursen's bug fix hour: 2022 edition (#24307) 2022-01-18 10:02:02 -06:00