jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-23 03:44:00 -05:00
Code Issues Projects Releases Wiki Activity
37,558 Commits 28 Branches 1 Tag
840fb65b2ac5e26919a7b792df9c88879809edab
Commit Graph

58 Commits

Author SHA1 Message Date
Evan Bonsignori
3f9651fbdf react page translation audit fixes (#35071) 2023-03-01 07:28:26 +00:00
Hector Alfaro
d34829ed16 Unique headers for REST operation components (#34986) 2023-02-27 19:07:56 +00:00
Grace Park
8c04f7aa19 Update api.github.com to HOSTNAME for REST enterprise server examples (#34951) 2023-02-22 17:51:12 +00:00
Robert Sese
e5370a5990 Feature Branch: Global Nav Phase 2 (#34359) 
Co-authored-by: Grace Park <gracepark@github.com>
Co-authored-by: Joe Oak <41307427+joeoak@users.noreply.github.com>
 2023-02-13 17:37:47 +00:00
Grace Park
6ca03c8125 Remove breaking and unnecessary style (#34544) 2023-02-08 00:15:10 +00:00
Grace Park
dbf220fa0c Search Results page updates (#34498) 2023-02-07 21:51:47 +00:00
Peter Bengtsson
b240055443 Permissions statement rendering on automated pages (#33718) 2023-01-03 19:44:44 +00:00
Robert Sese
b476eb4cbc show media type for REST examples dropdown (#33425) 2022-12-12 20:46:49 +00:00
Grace Park
e3f8f71c42 Rest api versioning redo (#33011) 
Co-authored-by: Rachael Sewell <rachmari@github.com>
Co-authored-by: Sarah Edwards <skedwards88@github.com>
Co-authored-by: Grace Park <gracepark@Graces-MacBook-Pro-2.local>
Co-authored-by: Sarah Schneider <sarahs@users.noreply.github.com>
Co-authored-by: Sarah Schneider <sarahs@github.com>
 2022-11-28 11:55:02 -08:00
Grace Park
a0536f8063 Add required query params to examples (#32248) 2022-11-10 21:17:34 +00:00
Grace Park
7190f42fc2 Fix enumerated parameters bg color (#32454) 2022-11-10 18:43:51 +00:00
dependabot[bot]
719e72a2ed Bump github-slugger and @types/github-slugger (#32260) 
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
Co-authored-by: Rachael Sewell <rachmari@github.com>
 2022-11-03 20:44:02 +00:00
Evan Bonsignori
d5cf8700ab Persist tab state in query params for linking (#31499) 2022-10-12 11:43:31 +00:00
Robert Sese
3d45346c34 New nested param table styles for REST (#30862) 2022-09-20 12:57:49 -07:00
Manuel Bergler
219638d7d4 Fix Management Console API code samples (#30455) 2022-09-06 15:58:04 +00:00
Grace Park
543b3eee9d Unbreak for code in rest tables and remove unnecessary import (#30314) 2022-08-29 17:12:00 +00:00
Rachael Sewell
28423ba069 simplify openapi schema parsing (#30192) 2022-08-24 22:14:39 +00:00
Rachael Sewell
961f985cfe Revert "Refactor openapi table func" (#30040) 2022-08-17 17:24:11 -07:00
Rachael Sewell
792f4c626a Refactor openapi table func (#29924) 2022-08-17 13:46:15 -07:00
Rachael Sewell
b552180c04 remove unused properties from decorated rest schemas (#29881) 2022-08-12 00:09:41 +00:00
Peter Bengtsson
f966792fb5 refactor ClientSideRedirectExceptions (#29737) 2022-08-08 20:42:59 -04:00
Peter Bengtsson
aa727c4f70 refactor clientsidehighlight (#29713) 
* refactor ClientSideHighlight

* names

* names again
 2022-08-08 20:17:58 +00:00
Rachael Sewell
dea3da2427 Add lazy syntax highlighting hook (#29610) 2022-08-04 21:23:22 +00:00
Rachael Sewell
aa8890ade6 add LinkIconHeading component (#29258) 2022-08-04 00:00:34 +00:00
Rachael Sewell
425e052816 remove nested markdown component (#29250) 2022-07-26 18:08:05 +00:00
Rachael Sewell
26e4dbc4bf refactor rest context provider to be generic (#29021) 2022-07-14 14:09:38 +00:00
Grace Park
97212c5114 Fix reactions and search large rest pages (#29012) 
* fix reactions and search large rest pages

* remove white space at the end
 2022-07-13 21:08:21 +00:00
Grace Park
822fe2926b Megabranch: Upgrade primer/react (#28458) 
* upgrade primer/react

* upgrade

* using deprecated

* remove lib"

* Upgrade primer/react: Upgrade Label (#28502)

update Label to primer/react 35.2.2

* fix merge conflicts

* primer/react v35: update ActionList (#28467)

* Update to v35 ActionList for LearningTrack

* Update to v35 ActionList for ArticleList

* Update to v35 ActionList for ProductArticleList

* Update to v35 ActionList for TableOfContents

* Update to v35 ActionList for ProductCollapsibleSection

* Update to v35 ActionList for RestCollapsibleSection

* Update to v35 ActionList for SidebarHomepage

* Update to v35 ActionList for MiniTocs

* Update to v35 ActionList for Search

* Extra div for rendering test

* One less div for rendering test

* All the style updates for v35 ActionList

* Works without setting as an li which is already the default (didn't before for some reason)

* Use deprecated ItemInput for now

* Picker update for primer/react (#28485)

* update picker

* inline picker for mobile

* set width to auto

* Update components/ui/Picker/Picker.tsx

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

* update

* Update Picker.tsx

* update onselect

* checking language code

* move language cookie setting to language picker

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

* Resolve package merge conflicts

* fresh npm install

* Primer update UnderlineNav (#28582)

* update underlinenav for primer/react update

* update tests

* update switches test

* update one last label

* update header test"

* remove href in underlinenav

* update rendering tests

* update cursor

* primer/react v35: update DropDownMenu to ActionMenu (#28576)

* Update to v35 ActionMenu for ArticleCards

* Update to v35 ActionMenu for Search

* Set button to inline-block

* Put the props on the overlay

* Update test for ActionMenu markup

* update package

* update package lock

* primer/react v35: CodeLanguagePicker update from SelectMenu to ActionMenu (#28625)

* Use octicon for menu down arrow

* Update to v35 ActionMenu for CodeLanguagePicker

* update to SubNav

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

* update package-lock

Co-authored-by: Robert Sese <734194+rsese@users.noreply.github.com>
Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
 2022-07-11 11:51:18 -07:00
Tim Rogers
037d6328b8 Recommend an Accept header without V3 in it when documenting our REST API operations (#28477) 
* Recommend an `Accept` header for REST API requests which doesn't mention V3

In the documentation for every REST API, in the "Headers"
section, we say for the `Accept` header that:

> Setting to `application/vnd.github.v3+json` is recommended.

Putting the V3 bit in doesn't actually do anything - in fact,
a high proportion of API consumers don't do it - and this
recommendation is going to be confusing once we launch our
new API versioning. This recommends that people use
`application/vnd.gitrhub+json` instead.

We could just recommend `application/json` - I'd be in favour
of that! - but I'm trying to make this change as small as
possible.

* Update cURL and GitHub CLI code examples to use an `Accept` header without V3

Co-authored-by: Sarah Edwards <skedwards88@github.com>
 2022-06-29 15:50:07 +00:00
Rachael Sewell
e15a73aaf5 rest default values for false not rendering (#28451) 2022-06-13 17:01:21 +00:00
Peter Bengtsson
5b6852dffb rest reference pages should have body and lead in sync search (#27961) 
* rest reference pages should have body and lead in sync-search

* tests passing
 2022-05-24 16:10:03 -04:00
Peter Bengtsson
67064b14c9 fix "Preview notice" anchor link (#27767) 2022-05-17 17:32:41 -04:00
Grace Park
2c56b5fdea Fix REST small bugs (#27484) 
* fix lucas found bugs

* remove language-

* update getLanguageHighlight

* add back launch.json

* remove line break
 2022-05-11 12:57:14 -07:00
Grace Park
f5fa66c452 update to size 16 per design and add d-flex (#27450) 2022-05-04 04:15:35 +00:00
Rachael Sewell
97fe617e15 adding enums back to rest param table (#27448) 2022-05-03 23:47:06 +00:00
Grace Park
f1f96c6a3a update to design feedback (#27420) 2022-05-02 17:03:21 -07:00
Rachael Sewell
5f4f858b94 REST two-pane layout (#26954) 2022-05-02 10:10:33 -07:00
Grace Park
e087622e1f REST Docs: update H3 to H2 operation heading (#27242) 
* update H3 to H2 operation heading

* update rest test to h2
 2022-04-27 17:22:21 +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
Rachael Sewell
02dbebbef3 render existing openapi examples (#26405) 2022-04-11 16:09:03 +00:00
Hector Alfaro
ba27b2e62c use functional variables 2022-04-05 18:43:11 -04:00
Hector Alfaro
cd732d19e1 override bg on rest toc for better contrast 2022-04-05 12:29:40 -04:00
Rachael Sewell
622eda013c change error codes table to all status codes table (#26518) 2022-03-29 13:16:34 -07:00
Rachael Sewell
7f3b2597ad Rest required previews are deprecated (#26527) 2022-03-29 12:52:12 -07: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
Grace Park
c26936f900 fixing styling on code blocks for rest pages (#26237) 2022-03-16 20:06:05 +00:00
Robert Sese
50a8de0769 Separate REST error responses (#26082) 
* Add error response variant

* Add response table styles

* Already filtered

* Don't need these styles

* Fallback to http code status messsage

* Add translation strings

* Proper heading level

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

* Match table styling with params table

* Typing unnecessary

Co-authored-by: Peter Bengtsson <mail@peterbe.com>

* Typing unnecessary

Co-authored-by: Peter Bengtsson <mail@peterbe.com>

* Work with the status code as a number

* Move error responses to operation end

* Make RestResponseTable a standalone component

Co-authored-by: Grace Park <gracepark@github.com>
Co-authored-by: Peter Bengtsson <mail@peterbe.com>
 2022-03-15 21:14:53 +00:00
Grace Park
21b59b5805 Move mini tocs rest + collapsible (#26069) 
* starting minitocs change

* moving rest mini tocs and adding functionality to collapse

* adding some comments

* update margins

* minor updates: fix scroll to top button add padding to resthttpmethod verbs and background color for nested arrows in minitocs

* 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>

* fix comment

* fix wording and z index

* bring back articlegridlayout

* updating margins for lg and xl

Co-authored-by: Rachael Sewell <rachmari@github.com>
 2022-03-14 10:50:53 -07:00
Grace Park
7850f08058 Update key to rerender RestCodeSamples (#26093) 2022-03-11 09:40:45 -08:00
Rachael Sewell
2f925d57a3 Remove lazy highlighting for now (#26091) 2022-03-10 21:12:38 -08:00