1
0
mirror of synced 2025-12-26 14:02:45 -05:00
Commit Graph

84 Commits

Author SHA1 Message Date
Grace Park
10fea98af5 Search updates larger font (#27838)
* removing search from home page and adding to header

* remove homepage search

* adding description

* update to f5

* remove homepage search test

* removing homepage search rendering test

* showing preview of larger font

* update wording at breakpoint

* update to short description everywhere

* Update components/homepage/HomePageHero.tsx

Co-authored-by: Joe Oak <41307427+joeoak@users.noreply.github.com>

* remove unnecessary stylesheet

* Update data/ui.yml

Co-authored-by: Janice <janiceilene@github.com>

Co-authored-by: Joe Oak <41307427+joeoak@users.noreply.github.com>
Co-authored-by: Janice <janiceilene@github.com>
2022-05-20 12:12:36 -07:00
Rachael Sewell
97fe617e15 adding enums back to rest param table (#27448) 2022-05-03 23:47:06 +00:00
Rachael Sewell
5f4f858b94 REST two-pane layout (#26954) 2022-05-02 10:10:33 -07: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
Ritesh Patil
ce5f599a4e fix: Rephrase search label; add an aria description label to the search input 2022-04-07 08:26:28 +00:00
Rachael Sewell
622eda013c change error codes table to all status codes table (#26518) 2022-03-29 13:16:34 -07: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
Robert Sese
58286e0eb6 Add missing key for GraphQL template reusable (#26045)
Co-authored-by: Peter Bengtsson <mail@peterbe.com>

Co-authored-by: Peter Bengtsson <mail@peterbe.com>
2022-03-09 16:13:59 -06:00
Grace Park
9b39fcbce3 Refactor parameter tables (#25676)
* reactify rest pages

* add space

* speed up pages by only sending applicable rest operations

* reactify rest operation part 1

* remove restpage

* sync translations directory with origin/main

* remove translation file

* clean up

* fix openapi tests

* fix tests

* remove unused variables

* add apps available page component (#25086)

* simplify getRest module

* add code sample component

* revert translation files

* revert translation files

* update tests

* add rest response and notes

* refactor and create codeblock and add styling changes from design systems

* nested all returned jsx into one single fragment

* update style name

* remove unnecessary div

* update title and add response max height and overflow

* refactor entry to RestOperation component

* cleanup types and unique keys

* update decorated files

* Rest page data (#25346)

* update endpoints for apps layout

* remove null type

* Update components/rest/CodeBlock.tsx

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

* updating renderTableRows

* cannot set p tag - should be div

* Ashs new feedback on the code blocks

* remove rest html pages

* Removing and updating decorated files (#25484)

* removing and updating decorated files

* bring back default tool

* fix tests

* add types

* fix styling in nested tables

* semantic changes

* adding unique key index

* remove unnecessary styling

* update styling for categories

* place app file in own directory

* update types

* update function in code samples

* fix some bad conflict resolution

* add rest banner back to rest pages

* Move all rest Markdown to data directory (#25598)

* Update components/rest/RestNotes.tsx

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

* adding translation (#25673)

* revert change to Dockerfile

* refactor parameter tables

* move toc to server side

* adding missing files

* updating spacing

* update body table

* Update components/rest/BodyParametersRows.tsx

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

* adding Fragment

* remove key from tr since it is on Fragment

* move around imports

* Update components/rest/BodyParametersRows.tsx

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

* Update components/rest/BodyParametersRows.tsx

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

* Update components/rest/ParameterRows.tsx

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

* Update components/rest/ParameterRows.tsx

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

* Update components/rest/BodyParametersRows.tsx

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

* Update components/rest/BodyParametersRows.tsx

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

* Update components/rest/BodyParametersRows.tsx

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

* small changes and adding anchor link to table instead of empty div

* adding name type and description to translation

* adding more translation

* refactor and break out ChildBodyParameterRows

* fix table css

* check

* change the rest parameters table to fixed to show all description

* update name to match

* run prettier

* Update components/rest/RestCodeSamples.tsx

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

* Update components/rest/ChildBodyParametersRows.tsx

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

* Update components/rest/ChildBodyParametersRows.tsx

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

* Update components/rest/BodyParametersRows.tsx

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

* updating CHildBodyParameterRows

* run prettier

Co-authored-by: Rachael Sewell <rachmari@github.com>
Co-authored-by: Peter Bengtsson <mail@peterbe.com>
2022-03-01 09:39:00 -08:00
Rachael Sewell
2ade7d8489 reactify rest pages (#25005) 2022-02-28 18:30:54 +00:00
Robert Sese
9c8ab14c46 Set meta description on homepage (#25546)
* Set meta description on homepage

* Update data/ui.yml

Co-authored-by: Janice <janiceilene@github.com>

* Better naming

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

* Update string key

* Always rendered

Co-authored-by: Emily Gould <4822039+emilyistoofunky@users.noreply.github.com>
Co-authored-by: Janice <janiceilene@github.com>
Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
2022-02-28 18:24:57 +00:00
Robert Sese
2e4187733f Add link to versions doc in version picker (#25012)
* Add link to 'about versions' in version picker

* Add translation string

* Match article short title

* Better text contrast

* Key names is 'docs_versions'

* 'About versions'

* Show version picker when only 1 version

Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
Co-authored-by: Laura Coursen <lecoursen@github.com>
2022-02-22 17:53:32 +00:00
Robert Sese
62ce173b76 Fix when we show the 'All Enterprise Releases' link (#25002)
* Enterprise versions start with 'enterprise-server'

* Show only if all versions are ghes versions

* Show link if there's any ghes versioning
2022-02-04 21:59:02 +00:00
Rachael Sewell
bd0cc83d73 use accessible text for view all links (#24747) 2022-01-31 22:02:29 +00:00
Anosike Osifo
ec73762b3e Add GHEC Trial CTA to header of docs.github (#23324)
* Add GHEC Trial CTA to header of docs.github

* use i18n logic

* add signup cta

* add signup cta

* Update the Trial CTA href to allow users choose trial plan

* Update logic to conditionally display signup CTA. Also remove GH EC Trial CTA

* update logic to use && operator

* fix wrapping search bar bug
2022-01-28 20:15:54 +00:00
Rachael Sewell
f9095482cf accessible description for learning paths (#24742) 2022-01-27 22:01:49 +00:00
Peter Bengtsson
f2f679550d display possible search error (#24429)
* display possible search error

* feedbacked
2022-01-19 21:41:17 +00:00
Robert Sese
d0db00cd98 a11y: match picker label with current selection (#24321)
* Match label with selection

* defaultText is a better default

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

* No longer used

* Also no longer used

* No longer used in the dropdown pickers

* Add translation strings for pickers

* Use translated strings in picker components

Co-authored-by: Peter Bengtsson <peterbe@github.com>
2022-01-19 18:43:31 +00:00
Robert Sese
54af81acd5 a11y: update code example search (#24226)
* Search on submit

* Should be a ul

* Fix broken link

* No search on change event

* Add translation strings

* Add role for the 0 results message

* Update test with new search behavior

* Make search input a controlled component

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

* Trim whitespace in search text

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

* Better variable names

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

* Update visible results count in useEffect

* Control the input's value with the typed state

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

* Inline the submit handler

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

Co-authored-by: Peter Bengtsson <peterbe@github.com>
2022-01-19 12:53:50 +00:00
Robert Sese
76b0b5ade1 a11y: survey email validation (#24159)
* Add email error state checking

* Clear email error on cancel

* Disable submit if email is invalid

* Add Primer-ized error message

* Add aria attributes

* Better function name
2022-01-08 00:01:42 +00:00
Grace Park
47de433865 Accessibility Search updates and additional minor changes (#24136)
* update to use heading markup

* updating to h3 for accessibility

* increase opactiy to meet 5.5:1 color contrast ratio

* update opacity to meet color contrast ratio

* update styling to match original but use heading markup

* remove aria-hidden for accessibility

* add h1 title search results and update scroll tip colors

* add number of matches

* remove no results since we are showing 0 results

* add overflow to fix border bottom on version search

* Update components/Search.tsx

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

* Update components/Search.tsx

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

* incorporating feedback and update padding

Co-authored-by: Peter Bengtsson <peterbe@github.com>
2022-01-07 21:29:49 +00:00
Robert Sese
bcb1b3c8bc Use lang attribute and translate picker aria-label (#24096)
* Translate picker aria-label

* Use lang attribute
2022-01-05 23:28:05 +00:00
Robert Sese
a2bd8ae67f Add support for videos to landing pages (#23801)
* Add new video properties frontmatter

* Handle video links in the middleware

* Video links don't have intros, authors, or full titles

* Make videos available from context

* Add default video heading

* Add basic tests for videos

* tmp videos test

* Remove stray test debugging

* more tmp videos testing

* Add videos test fixture

* Revert "more tmp videos testing"

This reverts commit 382946a5603ff217014797f77f37216bb8bb6c9c.

* Revert "tmp videos test"

This reverts commit 8767d0eaf08bd4ca04e2dacd12d476a2506c0367.
2021-12-17 11:09:00 -06:00
Grace Park
ea0e3efd61 update to add explicit ask for email (#23713) 2021-12-14 20:03:44 +00:00
Matt Pollard
b3e1ff4e89 Update documentation for GitHub AE's December 2021 release (#23405) 2021-12-07 10:36:37 +01:00
Grace Park
4ff5167e51 Updating name: sublanding to guides and using DropdownMenu for type/topics filter (#23290)
* updating sublanding to guides page and using DropdownMenu primer component

* fix linting error

* remove unnecessary import

* updating translation files

* move data-testid

* trying to fix test

* fix browser tests

* Update content/README.md

Co-authored-by: Francis <15894826+francisfuzz@users.noreply.github.com>

Co-authored-by: Francis <15894826+francisfuzz@users.noreply.github.com>
2021-12-02 18:43:33 +00:00
Rachael Sewell
0244fda807 search improvements (#22443) 2021-11-10 11:11:28 -08:00
Jeroen Rietveld
24e4c3407b Make guide filter accessible (#21380)
* Make guide filter accessible

Explain that the fields will filter a list.
Display a status message indicating the number of results found.

* update no guides found display, fix yaml issue

Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
Co-authored-by: Mike Surowiec <mikesurowiec@users.noreply.github.com>
2021-10-04 18:11:11 +00:00
Mike Surowiec
d81f51ebf7 Picker improvements (#21765)
* close Language and ArticleVersion pickers after click

* cleanup ArticleGridLayout due to VersionPicker changes

* fix tsc errors resulting from primer upgrade

* fix / update tests

* cleanup mobile pickers visual consistency

* use btn-sm on VersionPicker

* update translation and close on click for enterprise releases

Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
2021-09-30 20:22:13 +00:00
Mike Surowiec
2a25efcd8e Scope Search scss (#20964)
* scope Search scss, reduce custom styling

* use translation for loading and no results found

* remove unnescessary test
2021-08-23 09:15:39 -04:00
Kevin Heis
b1374fd8ee Remove extraneous sentence on survey (#20895) 2021-08-17 11:20:56 -07:00
Mike Surowiec
e26a3446a7 SubLanding page filter (#19918)
* sub-landing: implement filtering in react, other cleanup
2021-06-15 18:16:24 +00:00
Mike Surowiec
a88e99c83a Reactify: release notes (#19799)
* reactify release-notes pages

* update GHAE/ES react release notes to not rely on javascripts/release-notes.js
2021-06-09 20:44:32 +00:00
Kevin Heis
26a8e61d3a Update survey to use React/TS (#19728)
* Update survey to use React/TS

* Working survey form in react land

* A little cleanup

* Update Search.tsx

* Update Survey.tsx

* Remove token field from schema entirely, just let it fail validation

* Update events.js

* Update survey.html

* use Link component

* Use enum for state

* Update old to match new
2021-06-08 17:34:45 +00:00
Mike Surowiec
37499b80d2 Reactify article page rendering (#19679)
* feat: reactify article page rendering

* feat: add LearningTrackNav

* fix: use plain text title for article
2021-06-07 22:56:33 +00:00
Kevin Heis
516106b7c5 Rename "helpfulness" to survey (#19727) 2021-06-04 12:22:31 -07:00
Sarah Schneider
0909729193 change the banner text depending on whether the currentWeek prop is set to true or false in the YAML 2021-05-28 11:33:06 -04:00
Sarah Schneider
221de41388 more merge updates 2021-05-24 12:10:58 -04:00
Sarah Schneider
a5d52dcef0 Add landing page for GitHub Enterprise (#19041) 2021-05-12 11:55:32 +00:00
Mike Surowiec
f0fe065cef feat: implement changelog feed, guide section 2021-05-10 15:17:52 -07:00
Sarah Schneider
7ae3bf204a remove the upgrade banner for AE 2021-05-07 19:59:32 -04:00
Mike Surowiec
8598b600f3 wip: add LandingHero, FeaturedArticles 2021-05-07 16:35:11 -07:00
Sarah Schneider
6578e9e164 update the UI text 2021-05-07 17:32:26 -04:00
Sarah Schneider
baf661cb54 Merge branch 'main' of github.com:github/docs-internal into render-product-landing-introlinks-dynamically 2021-04-27 20:50:08 -04:00
Sarah Schneider
cdcc0aa394 no need for reference_guides, only use reference prop 2021-04-27 20:47:41 -04:00
Sarah Schneider
1e8baf292a Merge branch 'main' into add-ghes-releases-link-to-versions-dropdown 2021-04-27 20:13:53 -04:00
Sarah Schneider
35a12da7f9 remove no longer needed ui props 2021-04-26 15:34:51 -04:00
Sarah Schneider
982eeb04e0 use the keys as hooks for frontmatter props 2021-04-26 12:19:18 -04:00
Sarah Schneider
aa2ef4137b make tooltip work on the scroll button 2021-04-22 12:54:30 -04:00
Sarah Schneider
94ec691215 update tooltip text 2021-04-22 12:17:07 -04:00