1
0
mirror of synced 2025-12-21 02:46:50 -05:00
Commit Graph

105 Commits

Author SHA1 Message Date
Hector Alfaro
4b27213cc6 Merge branch 'main' into hectorsector/consolidate-tool-picker 2022-05-24 11:01:46 -04:00
Hector Alfaro
91778790d8 clean up and comment tool picker stuff 2022-05-24 10:40:46 -04:00
Hector Alfaro
3b825a46d2 pull out tools from page.js and ToolPicker component 2022-05-23 10:48:49 -04:00
Peter Bengtsson
18504871b9 cache full rendering (#25424)
* cache full rendering

* still not working with gzip

* progress progress progress

* smaller

* hacky progress

* small fixes

* wip

* lock file

* wip

* wip

* package-lock updates

* wip

* search DOM in lowercase

* simplify

* with instrument

* improve test coverage

* mutateCheeriobodyByRequest

* fix

* remove renderContentCacheByContex

* disable render caching in sync-search

* diables things in github/github link checker

* gzip lru

* tidying up

* updated

* correct tests

* fix: move userLanguage to LanguagesContext

* Revert "fix: move userLanguage to LanguagesContext"

This reverts commit d7c05d958c71eaad496eb46764eb845d80b866ca.

* contexts ftw

* fixed rendering tests

* oops for got new file

* nits addressed

Co-authored-by: Mike Surowiec <mikesurowiec@users.noreply.github.com>
2022-05-23 12:12:09 +00:00
Lucas Costi
5cef9e2fe7 Remove Actions experimental articles (#27524) 2022-05-18 00:35:40 +00:00
Sarah Schneider
a9d3390c2f change hiddenNoBanner to noEarlyAccessBanner 2022-05-13 16:35:33 -04:00
Sarah Schneider
2962666b55 update banner component 2022-05-13 12:47:11 -04: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
Robert Sese
33c05d81ce Change product landing page introLinks to a general map of link titles to links (#26360)
* Add cta button to frontmatter and context

* Add cta to Page

* Render cta button in product landing hero

* Handle external links

* Add simple unit test for cta link

* Address feedback

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

* Actually push condition update

* Show it's an external link

* Refactor FullLink so we use Link once

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

* Custom link can also be null

* Rename 'cta' to 'custom' and make it the last introLink

* Update tests with 'cta' to 'custom' change

* Filter once

* Revert "Filter once"

This reverts commit a3f9a8a06b505d77fed47ca96a66c187c86c3c91.

* Update introLinks to a map of titles and URLs

* No more custom introLink in LandingHero

* Simplify introLinks processing

* introLinks can also be null

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

* more concise

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

* No longer necessary with the a plain introLinks map

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

* '.entries()` is simpler

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

* 'link' could be false depending on what version you're on

* Update test for new introLinks

Co-authored-by: Peter Bengtsson <mail@peterbe.com>
2022-04-01 11:01:37 -05:00
Peter Bengtsson
43f0e5270c remove GHEC signup button for dotcom_user cookied users (#26521) 2022-03-29 20:21:38 +00:00
Rachael Sewell
2ade7d8489 reactify rest pages (#25005) 2022-02-28 18:30:54 +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
Robert Sese
d31d6a5b4e a11y: add title text for view all links (#24193)
* Add optional 'view all' title text in the context

* Use viewAllTitleText in ArticleList

* Set viewAllTitleText for sections with 'view all' links
2022-01-11 01:30:10 +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
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
Kevin Heis
e3b2e820fd React tool picker (#23004)
* Working on tool picker

* Start on react version of tool picker

* Update ToolPicker.tsx

* Update tool-switcher.html

* Get it working

* Update browser.js

* Update browser.js

* Update ToolPicker.tsx
2021-11-29 23:04:06 +00:00
Amy Burns
c3bc538cd4 Add 2 pane layout to "Setting up Codespaces" docs and update IA (#21700) 2021-11-24 11:41:30 -08:00
Grace Park
5a809be3dc MiniTocItems: rerender tocs and fix bugs (#22948)
* add key to force rerender tocs

* move up platform specific to properly display none and go back to using contents

* remove i
2021-11-17 22:29:07 -08:00
Grace Park
0afdf66a08 Primer Update: Table of Contents (#22933)
* update to ActionList

* fix nested mini tocs

* adding key

* remove li and fix tests

* update font size to 14px

* remove border radius
2021-11-18 00:27:12 +00:00
Rachael Sewell
e919d5085d change version within search result window (#22702) 2021-11-12 22:01:08 +00:00
Mike Surowiec
7310fc998a Refactor display-platform-specific-content (#22665)
* refactor display-platform-specific-content

* update PlatformPicker tests and cleanup
2021-11-12 14:40:35 +00:00
Grace Park
75d41076a7 Article Layout Improvements (#22424)
* moving breadcrumbs to sticky header

* update scroll

* update color-bg-primary to color-bg-default

* change back to primary since were on primer 17

* add effect dependency

* not changing

* clip left box shadow of header and unmount

* update to default

* update breadcrumbs tests

* sticky editor
2021-10-29 19:57:07 +00:00
Mike Surowiec
b223df9a8d fix: includeGuides should always include topics array (#22455) 2021-10-28 16:14:30 +00:00
Edward Thomson
0fee9aedcd Landing page: groups of features (#22313)
* homepage: reduce padding below search area

Bring as much useful content up "above the fold".

* homepage: add groups for the front page sections

Group the homepage links into sections that map to the GitHub features
page (`/features`) plus two groups that are bespoke to the docs ("Get
started" and "Developers").

* homepage: update group design

Group the feature list area using the design exploration work by
@arisacoba.  Remove the description.

* homepage: remove ungrouped items from main area

Remove ungrouped items (like the external links) from the main feature
area.  Users can still navigate to ungrouped items in the sidebar.

* fix tsc error, use Link component

* homepage: support empty icon in group

Don't assume that we have icons everywhere on the landing page groups.

* homepage: drop octocat/invertocat

Looks weird with the modern icons, looks bad in dark mode.  Drop them
for now.

* homepage: document the childGroups frontmatter property

* homepage: don't test that sidebar == main content

We're reducing the links on the homepage in the main content area, but
the sidebar should be the complete list of products.  Remove the tests
that ensure that the main content area has all the sidebar content.  But
keep the tests that ensure that the sidebar content has all the links in
the main content area.

* homepage: remove "GitHub" doc set

The "GitHub" doc set "will be removed soon as we keep moving more content
out of it, so let's not include it here to keep the page more
evergreen."

* homepage: don't test that `/github` is linked on the main page

We're removing the `/github` doc set, and it's now not in the main page
grouped links.  Remove the test that `/github` exists, now look for
`/get-started`.

* homepage: use octicons instead of images

The images from https://github.com/features will be updated 🔜 - in
the meantime, let's use octicons which are consistent and give visual
interest.

* homepage: use octicons from @primer/octicons-react

Using the react components adds `<svg>` elements instead of `<img>`
elements, which lets the element use the current fill color, supporting
both light and dark themes.

Co-authored-by: Mike Surowiec <mikesurowiec@users.noreply.github.com>
Co-authored-by: Emily Gould <4822039+emilyistoofunky@users.noreply.github.com>
2021-10-22 17:58:16 +00:00
Grace Park
884556eb02 Adding effectiveDate frontmatter property (#22317)
* adding effectiveDate frontmatter property

* Update components/article/ArticlePage.tsx

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

* adding validation for correct date

* update to dateTime

* update to year month day

* update error date validation

* moving validation to getArticleContextFromRequest and moving id to div

* remove enteredDate

* Update content/README.md

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

Co-authored-by: Peter Bengtsson <peterbe@github.com>
Co-authored-by: Laura Coursen <lecoursen@github.com>
2021-10-20 19:40:13 +00:00
Grace Park
4727433baa Community redirect update to camel case and adding documentation (#21979)
* update to camel case

* add documentation on communityRedirect
2021-10-07 15:02:58 -07:00
Grace Park
9dd8ed7398 Bring back community redirect (#21971)
* add back

* adding community_redirect to page context based on parent

* update to use parentProduct

* bring back the link-secondary and text-bold
2021-10-07 18:58:31 +00:00
Mike Surowiec
85f6a43502 Mini TOC semantic rendering (#21836)
* semantic rendering of miniTocItems

* feat: create nested mini toc structure to simplify semantic rendering

* remove className usage of indentationLevel in miniToc rendering

* manually run script/graphql/update-files.js to update pre-rendered files

* use less brittle regex method to extract number
2021-10-04 10:48:42 -04:00
Grace Park
1211a3a92c Remove community_redirect and update all footer links for Codespaces, Discussions, and Sponsors (#21815)
* remove community_redirect and update all footer links to redirect to discussions for Codespaces, Sponsors, and Discussions

* Remove community_redirect

* Remove community_redirect

* Remove community_redirect

* Remove community_redirect

* Remove community_redirect

* Remove community_redirect

* Remove community_redirect

* Remove community_redirect

* Remove community_redirect

* Remove community_redirect

* Remove community_redirect

* Remove community_redirect

* Remove community_redirect

* Remove community_redirect

* Remove community_redirect

* Remove community_redirect

* Remove community_redirect

* Remove community_redirect

* Remove community_redirect

* Remove community_redirect

* Remove community_redirect
2021-09-30 23:07:51 +00:00
Grace Park
bfe529c40a Fixing index page body text rendering (#21811)
* fixing index page body text rendering

* always use renderedPage
2021-09-30 21:37:49 +00:00
Robert Sese
000799df17 Handle learning track paths from a different product (#21776)
* Add trackProduct property

* Fall back to learning track product URL param

* Add product URL param to learning track banner

* Add product URL param to featured track links

* Fix typo :(

* Add product URL param to learning track

* Add multi-product learning track tests

* Re-enable tests with a Code Security learning track

* Re-enable more tests with Code Security learning tracks

* Add more multi-product testing

* Update components/sublanding/LearningTrack.tsx

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

Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
2021-09-30 21:17:02 +00:00
Mike Surowiec
3125579983 remove currentLanguage from mainContext, use router.locale instead (#21716) 2021-09-27 14:40:43 +00:00
Robert Sese
2f6af3fe20 Render learning track banner on ToC landing page (#21634)
* Add learning track info to ToC landing page context

* Render learning track banner on ToC landing page
2021-09-22 01:02:29 -05:00
Kevin Heis
cdbbc63219 Send new analytics fields for path_language, path_version, path_product, path_article (#21562)
* Send new analytics fields for path_language, path_version, path_product, path_article

* Update DefaultLayout.tsx

* Update events.js
2021-09-17 19:22:54 +00:00
Lee Dohm
b500fd07d0 Use titlePlainText attribute since the title will be used for rendered text 2021-09-09 13:50:54 -07:00
Kevin Heis
4d0e9c70a3 Add new fields to analytics event context: status, page_type, page_document_type (#21115)
* Add new fields to analytics event context: status, page-type, page-document-type

* Update schema-event.js

* Typescript

* Add status meta to error pages

* Update DefaultLayout.tsx

* Update DefaultLayout.tsx

* Update building-and-testing-nodejs-or-python.tsx
2021-08-26 14:58:45 -07:00
Mike Surowiec
06d8f81401 Two-pane Experiment (#21092)
* pull changes from docs-playground

* cleanup, add callout banner

* cleanup linting and test fixes

* add discussion link

Co-authored-by: James M. Greene <JamesMGreene@github.com>
2021-08-26 14:19:40 -04:00
Kevin Heis
1cb2da024d Add opengraph tags to articles (#21089)
* Add opengraph tags to articles

* Update MainContext.tsx

* Update DefaultLayout.tsx
2021-08-26 14:18:58 +00:00
Rachael Sewell
c7ac98304a allow use of full titles on landing page (#20327) 2021-08-25 12:31:16 -07:00
Grace Park
5b59619d68 Adding Product feedback redirect (#20785)
* adding product feedback redirect for community on sponsors, discussions, and actions community link

* remove community redirect from actions and add to codespaces and add tests

* update wording for these links

* updating to add name of the button to frontmatter
2021-08-11 10:37:41 -07:00
Mike Surowiec
a511c95c7f SCSS and Component cleanup (pt 1) (#20572)
* turn article.scss into a module + componentized

* Update Survey to use only component styles, add cancel button

* Update GenericError + 404 page to use only standard classes

* update LearningTrack to not use markdown-body

* remove / consolidate stylesheets

* cleanup Graphiql explorer page and scss

* Componentize Breadcrumb styles

* Componentize DeprecationBanner styles

* scope h2 a link style to markdown-body

* cleanup nav, organize page-header and page-footer components

* remove unused scroll-button.scss

* organize LanguagePicker and ProductPicker

* add declarations file

* remove featured-links.scss, update tests

* update list utility and toc test

* fix bad merge resolution

* update breadcrumbs test
2021-07-29 17:27:20 +00:00
Mike Surowiec
a9a19ef6da Move languages out of MainContext (#20503)
* move languages off of MainContext

* load languages from request to workaround sharing the languages file
2021-07-29 13:36:11 +00:00
Mike Surowiec
9386571aa4 fix: use named export for all-versions (#20478)
* fix: use named export for all-versions

* run prettier
2021-07-22 19:29:00 +00:00
Mike Surowiec
6bc50f7e30 fix: filter hidden pages from the currentProductTree (SidebarProduct) (#20404)
* fix some async test things

* allow eslint to parse top-level awaits

* fix: filter out hidden pages closer to SidebarProduct usage
2021-07-20 12:32:35 -04:00
Grace Park
27aa5d92ea Remove FEATURE_NEXTJS Flag Part 1 (#20176)
* cleanup FEATURE_NEXTJS

* fixing some server tests

* updating article a for server tests

* update h2 to h4 map topic tests

* data off on TOCs

* updating dropdown article versions links

* Update so markdown renders in intros

* updating typo and all server tests are now passing

* remove nextjs feature flag

* head.js tests pass

* updating article-version-picker

* remove nextjs feature flag browser test

* update header.js tests

* fix page-titles.js test

* fix deprecated-enterprise versions

* adding early access

* testing

* getting childTocItem

* fixing table of contents to show child toc items

* updated to 2 because the sidebar article also has the same link

* remove comment

* updating pick

* Update TocLandingContext.tsx

* update package.json and change className to h4 for h2

* updating with mikes feedback

* remove a.active test

* React clean up: Delete unnecessary layouts/includes Part 2 (#20143)

* Delete unnecessary layouts

* setting back tests failing :(

* update layouts

* delete unnecessary includes

* remove github-ae-release-notes and updating layouts

* remove a.active test
2021-07-16 14:54:25 -07:00
Grace Park
d3cc64a6bc adding rendered page to early access index 2021-06-29 12:04:34 -07:00
Sarah Schneider
118747974e fix bugs in React 2021-06-23 12:54:17 -04:00
Sarah Schneider
15e33f05e7 Revert "Revert "Fix homepage versions dropdown" (#20087)"
This reverts commit f9f0b2ce86.
2021-06-23 10:12:36 -04:00
Matt Pollard
f9f0b2ce86 Revert "Fix homepage versions dropdown" (#20087) 2021-06-23 09:11:51 +02:00
Sarah Schneider
43c04966e5 update React components that use the homepage version 2021-06-22 15:16:01 -04:00