1
0
mirror of synced 2025-12-21 10:57:10 -05:00
Commit Graph

58 Commits

Author SHA1 Message Date
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
Amy Burns
e82f64f642 Add vscode as an option for the application selector (#21798)
* adding switcher to creating a codespace guide

* adding additional switcher for vscode and updating codespaces name

* using webui in codespaces coontext

* updating internal documentation

* remove default tool

Co-authored-by: hubwriter <hubwriter@github.com>
2021-10-07 14:57:45 +01: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
Martin Lopes
83dc407ada Restructure Actions guides (#21577)
Co-authored-by: Sarah Edwards <skedwards88@github.com>
Co-authored-by: Mike Surowiec <mikesurowiec@users.noreply.github.com>
2021-09-22 16:49:41 +10:00
Sarah Edwards
95bd8c84f9 [Aug 24, 2021] Top level CLI docs set (#20628)
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Co-authored-by: Mislav Marohnić <mislav@github.com>
Co-authored-by: Laura Coursen <lecoursen@github.com>
2021-08-24 15:44:25 +00: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
Amy Burns
acabc37604 [MERGE 8/11 @ 8:45am PT] Codespaces Megabranch (#20378)
Adding Codespaces docs
2021-08-11 11:46:35 -04: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
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
Kevin Heis
8a56437c93 Pretty format (#20352)
* Update prettier flow to include JS

* Run prettier

* ...run prettier
2021-07-14 14:35:01 -07:00
Kevin Heis
42e785b0a8 Migrate CommonJS to ESM (#20301)
* First run of script

* Get the app running --- ish

* Get NextJS working

* Remove `node:`

* Get more tests passing in unit directory

* Update FailBot test to use nock

* Update test.yml

* Update Dockerfile

* tests/content fixes

* Update page.js

* Update build-changelog.js

* updating tests/routing

* Update orphan-tests.js

* updating tests/rendering

* Update .eslintrc.js

* Update .eslintrc.js

* Install jest/globals

* "linting" tests

* staging update to server.mjs

* Change '.github/allowed-actions.js' to a ESM export

* Lint

* Fixes for the main package.json

* Move Jest to be last in the npm test command so we can pass args

* Just use 'npm run lint' in the npm test command

* update algolia label script

* update openapi script

* update require on openapi

* Update enterprise-algolia-label.js

* forgot JSON.parse

* Update lunr-search-index.js

* Always explicitly include process.cwd() for JSON file reads pathed from project root

* update graphql/update-files.js script

* Update other npm scripts using jest to pass ESM NODE_OPTIONS

* Update check-for-enterprise-issues-by-label.js for ESM

* Update create-enterprise-issue.js for ESM

* Import jest global for browser tests

* Convert 'script/deploy' to ESM

Co-authored-by: Grace Park <gracepark@github.com>
Co-authored-by: James M. Greene <jamesmgreene@github.com>
2021-07-14 13:49:18 -07:00
James M. Greene
7ee7a1aaaa Merge branch 'main' into feature-versioning 2021-06-22 15:28:34 -05:00
Grace Park
d3d1902414 Merge pull request #20017 from github/upgrade-esm
Enforce and Move to Top Level require
2021-06-22 11:27:48 -07:00
Sarah Schneider
4c0e21e762 lint 2021-06-22 10:59:32 -04:00
Sarah Schneider
512d29bf83 support ghae = next in frontmatter 2021-06-22 10:56:57 -04:00
Sarah Schneider
c4d6ae71a0 fix versions schema 2021-06-22 10:40:02 -04:00
Sarah Schneider
3ad7f24957 allow feature versioning in frontmatter schema 2021-06-17 11:42:46 -04:00
Grace Park
3f248976ad Merge branch 'main' of https://github.com/github/docs-internal into grace-header-styling 2021-06-10 18:08:33 -07:00
Felicity Chapman
23b0b84111 Add Code security landing and guides pages (#19650) 2021-06-10 20:14:56 +00:00
Grace Park
e0c6211b65 adding more styling and graphql changes - should be ready to run script 2021-06-10 09:32:16 -07:00
Sarah Edwards
340f663243 Add support for cURL in application selector (#19645) 2021-06-03 14:18:19 -07:00
Rachael Sewell
d9c336f6a6 add custom popular heading to landing pages (#19147) 2021-05-05 17:55:47 +00:00
Sarah Edwards
be8aa2bccb Add tabs for cli/desktop/ui (#19071) 2021-05-04 16:53:52 +00:00
Zeke Sikelianos
148c63c5dd i18n: define translatable properties in frontmatter schema (#18964)
* i18n: define translatable properties in frontmatter schema

* mark `product` frontmatter as translatable

* lint
2021-04-26 13:24:41 +00:00
Vanessa Yuen
bbd9f03f6e Populate product-landing "What's new" section using GitHub Changelog (#18328)
Co-authored-by: Jason Etcovitch <jasonetco@github.com>
Co-authored-by: Rachael Sewell <rachmari@github.com>
Co-authored-by: Sarah Schneider <sarahs@users.noreply.github.com>
2021-04-08 20:51:37 +00:00
Sarah Schneider
922c159449 lint 2021-04-01 15:42:59 -04:00
Sarah Schneider
73c67857a3 support the new frontmatter props 2021-04-01 15:27:58 -04:00
Sarah Schneider
b320016ea5 parse some of the landing page frontmatter so we can respect conditionals 2021-03-26 11:24:29 -04:00
Steve Winton
44d34f5c52 Add support for new contributor frontmatter object 2021-03-10 15:36:02 -06:00
Jason Etcovitch
e68e6a5185 Revert "Revert "Absorb @github-docs/frontmatter (#17783)" (#17793)" (#17799)
* Revert "Revert "Absorb @github-docs/frontmatter (#17783)" (#17793)"

This reverts commit 11baf43eee.

* Move revalidator to depedencies
2021-02-11 11:15:59 -05:00
Jason Etcovitch
11baf43eee Revert "Absorb @github-docs/frontmatter (#17783)" (#17793)
This reverts commit 1e96c03489.
2021-02-10 20:28:41 +00:00
Jason Etcovitch
1e96c03489 Absorb @github-docs/frontmatter (#17783) 2021-02-10 15:10:46 -05:00
Vanessa Yuen
4038e9ca85 Add topic property and filter to guides page (#17328)
Co-authored-by: Emily Gould <4822039+emilyistoofunky@users.noreply.github.com>
2021-01-29 12:32:31 +00:00
Vanessa Yuen
641ed02e81 Actions Guides sublanding page (#16740)
Co-authored-by: Emily Gould <4822039+emilyistoofunky@users.noreply.github.com>
Co-authored-by: Cynthia Rich <crichID@github.com>
2021-01-11 18:30:57 +01:00
Simran Spiller
3f8f75e116 YAGNI: Remove support for {% all %} 2020-12-11 01:05:23 +01:00
Simran
2a3fdd43ac Merge branch 'main' into default-platform 2020-12-09 02:06:46 +01:00
Simran Spiller
4dc1ce1322 Lint 2020-12-09 02:01:54 +01:00
Simran Spiller
64f2d638d5 Add support for defaultPlatform frontmatter
TODO: add 'all' to frontmatter schema enum?
2020-12-09 01:28:09 +01:00
Meg Bird
754ceda517 [Universe] Discussions Public Beta (#16547)
* Update README

* create structure for discussions landing page

* is everything broken

* [Universe] Dark mode (#16545)

* Fix title

* Add Discussions product

* Correct title

* Correct title

* Move quickstart article

* Move quickstart back out into article

* Add and incorporate reusables

* Move information about search

* Draft conceptual information

* Draft best practices

* Draft further reading

* Draft product introduction

* Draft introduction

* Add author metadata

* Pluralize

* Fix typos

* Add introduction

* Bump Octicons

* Add some reusables

* Add images

* Revise article

* Draft article

* Change word

* 🔪 the gerund

* Add reusable

* Revise introduction

* Revise list

* Simplify

* Revise reusable

* Fix reusable; add context

* Rename reusable

* Deduplicate conceptual information

* 🔪 gerund

* Add link to further reading

* Move link and dispose of tip

* Delete space

* Add images

* Add conceptual section

* Add word

* Delete newline

* Revert package.json to state on main

* Tweak images

* Draft article

* Add product name

* Remove beta note

* Use product name for future-proofing

* Begin adding search information

* Fix copypasta

* little edits

* build out a bit more of the guides content

* Don't mention integrations for now

* Escape quote

* Remove authorship information for new defaults

* Finish drafting article

* Replace encoded character to match description

* Revise away inline link

* Accommodate 'for more information' in reusable

* Fix links

* Fix one last bit of copypasta

* Update indices

* Temporarily remove heading

* Update introduction

* Add new article 💀

* Remove commits from universe-2020-megabranch

* Add article 💀

* update with a very rough draft

* Add content about collaboration options to "About repositories"

* Add content about discussions to "About issues"

* Reorder content

* Add is:discussion query

* update with a few mmore fleshed out sections

* update with more structure

* Add reusable

* Add screenshots

* Clear way for actual procedural

* Discussions landing page "Communities" section (#16692)

* Make button Overview-able

* Make card filtering more extensible

* Guard for missing attributes

* Use arbitrary dataset attributes

* Add section with discussions-community-card

* Tweak show more button behavior

* Conditionally show "Show more"

* Add beta_product frontmatter/label

* Remove beta callout note

* Hide changelog with no items

* Finish importing community info

* Fix borked markup

* Omit search abr

* Two columns should actually be two columns

* Use org image, change card layout

* Add two more examples

* Fix title

* Escape quote

* Escape another quote

* Draft article

* Lower case

* Relocate conceptual information

* Update qualifier name

* Draft article

* Add conceptual information and links

* Remove duplicative section

* Fix copypasta

* Revise reusable

* Update link

* Add content on categories

* Lint the discussions YAML file

* Update introduction and permissions

* 

* Reusablize; fix link

* more planning content stuff

* Escape quotes

* Align prerequisites

* Soften

* Clean up prerequisites

* Fix titles; version; add screenshot

* Fix links

* Actually fix links

* Use better variable

* Mention pinning

* Update screenshots

* Add screenshot

* forgot to committ

* update with reusable

* add that screenshot

* beef up landing page a bit

* remove extra space

* messed that up

* fix hardcoded linkks weirdo

* fix tests

* update with permissions content

* update with placeholder

* filter out standalone category files from test

* update

* update @becca's  feedback

* update with more feedback

* so many updates

* fix links

* fix some more tests

* flesh some more things out

* update with further reading blah blah

* fix some things

* remove the gate-features label for beta ship only

* Add discussions video to product landing page (#16759)

* Add discussions video placeholder

* This might work maybe

* fix tests

* apply all of @becca's and @lecoursen's  feedback ❤️

* rename to fix test

* Revert "Add discussions video to product landing page (#16759)"

This reverts commit 2247e5d0881ca6b36cee421218e8341a7cc12ac7.

* update with test fix

Co-authored-by: Melanie Yarbrough <11952755+myarb@users.noreply.github.com>
Co-authored-by: Laura Coursen <lecoursen@github.com>
Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
Co-authored-by: Jason Etcovitch <jasonetco@github.com>
Co-authored-by: Sarah Schneider <sarahs@github.com>
2020-12-07 15:00:35 -07:00
Jason Etcovitch
a7466b685b Actions video (#16744)
* Support video frontmatter

* Add CSP rule

* Actually put in the video
2020-12-03 21:18:42 +00:00
Octomerger Bot
218d08f38d Branch was updated using the 'autoupdate branch' Actions workflow. 2020-12-03 12:53:19 -08:00
Sarah Schneider
82644efc7c Merge branch 'main' of github.com:github/docs-internal into hidden-docs-alt 2020-12-03 12:06:18 -05:00
Kevin Heis
11d8e415da Check repository references (#16680)
* Check repository references

* Remove "foundRepoNames" that I used to find all the unique names

* A little speed up with Set

* Ignore a few files

* Remove remaining references

* Update README.md
2020-12-03 16:41:03 +00:00
Kevin Heis
07a78222ae Merge branch 'main' into experiment-with-react-and-mdx 2020-12-02 14:10:51 -08:00
Kevin Heis
dd02bfa007 Merge main 2020-11-16 10:07:53 -08:00
Jason Etcovitch
dd91c5a707 "Guides" section of the Actions landing page (#16216)
* Add custom hover shadows

* Support avatars

* Add guide-card include

* Use it in product-landing

* Add gradient styles

* Add guides frontmatter

* Use guideArticles instead of full objects

* Add support for authors

* Add support for category header

* Just pass the whole page

* Use it

* guide.url => guide.href

* Use `*.githubusercontent.com`

* Fix mobile card width

* Remove showDescription check

* Use featureLinks.guideCards

* Forgot an if

* Remove support banner

* Just use login instead of name/avatarUrl

* Change card spacing

* Use circular avatars

* Add margin beneath "Guides"

* Use smaller font

* Even moar spacing

* Remove category

* Remove lead text, move button to bottom right

* update guide cards

* Change author of setting up ci to GitHub

* Attribute node js guide to GitHub

* Add author tag to powershell guide

* update top guides section with correct actions links

* Enforce size for single avatars

* Adjust spacing

Co-authored-by: Cynthia Rich <crichID@users.noreply.github.com>
2020-11-11 12:53:46 -05:00
Sarah Schneider
0cf94f26b7 Merge branch 'main' of https://github.com/github/docs-internal into hidden-docs-alt 2020-11-03 17:09:22 -05:00