Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pull] master from segmentio:master #59

Merged
merged 53 commits into from
Sep 11, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
23389eb
README updates for the main repo, and a light overview on the docs su…
akleiner2 May 18, 2021
a2048b7
Fixup path generation for in-progress pattern components (#1203)
akleiner2 May 18, 2021
fadc437
v6.0.1
kamebkj May 18, 2021
40b0a43
update readme hero image on github (#1204)
kamebkj May 18, 2021
9beb4d4
update doc to use evergreen-ui ^6.0.0 (#1206)
kamebkj May 20, 2021
872eee8
Fix layout inconsistency for removeable alert's X button (#1210)
May 22, 2021
3dbaad9
Fix Select Menu + deselect example (#1213)
akleiner2 May 24, 2021
95e9bfd
Bring back icon search in the docs (#1227)
akleiner2 Jun 9, 2021
607458a
Updates to lint infra and DX to make things a bit smoother (#1229)
akleiner2 Jun 9, 2021
c15d2e7
Add Position to code sandbox import regex (#1230)
WarrenGreen Jun 9, 2021
6d21921
Lint staged fix (#1231)
kamebkj Jun 9, 2021
99af9f7
New pattern - Empty States (#1238)
kamebkj Jun 30, 2021
736b278
v6.1.0
kamebkj Jun 30, 2021
ca36db0
include yarnhook in devDeps so it doesnt fail when not globally insta…
Jul 14, 2021
ea07334
Remove circle CI in favor of solely running GH Actions (#1249)
akleiner2 Jul 14, 2021
d555fc0
fix storybook globs constantly rebuilding (#1250)
Jul 14, 2021
086f040
Eslint cleanup (#1251)
Jul 14, 2021
bbae505
Bump ua-parser-js from 0.7.17 to 0.7.28 in /examples/ssr-next (#1177)
dependabot[bot] Jul 14, 2021
54dd233
Bump lodash from 4.17.19 to 4.17.21 in /examples/ssr-next (#1184)
dependabot[bot] Jul 14, 2021
0e51140
Bump lodash from 4.17.19 to 4.17.21 in /codemods (#1190)
dependabot[bot] Jul 14, 2021
09c50dc
Bump postcss from 7.0.35 to 7.0.36 in /docs (#1232)
dependabot[bot] Jul 14, 2021
a916c43
Bump trim-newlines from 3.0.0 to 3.0.1 (#1228)
dependabot[bot] Jul 14, 2021
09377b8
Bump hosted-git-info from 2.5.0 to 2.8.9 in /examples/ssr-next (#1185)
dependabot[bot] Jul 14, 2021
f2f258b
Bump ws from 7.2.5 to 7.5.3 in /codemods (#1252)
dependabot[bot] Jul 14, 2021
8ebc7f5
Bump browserslist from 4.2.1 to 4.16.6 in /examples/ssr-next (#1214)
dependabot[bot] Jul 14, 2021
fac51b2
Bump hosted-git-info from 2.8.8 to 2.8.9 in /codemods (#1191)
dependabot[bot] Jul 14, 2021
2328e47
Bump set-getter from 0.1.0 to 0.1.1 in /examples/ssr-next (#1237)
dependabot[bot] Jul 14, 2021
c404bdf
Bump postcss from 7.0.35 to 7.0.36 (#1240)
dependabot[bot] Jul 14, 2021
42bc22b
Bump ws from 7.4.5 to 7.5.3 (#1253)
dependabot[bot] Jul 14, 2021
3261399
Bump ini from 1.3.5 to 1.3.8 in /examples/ssr-next (#1254)
dependabot[bot] Jul 14, 2021
8a9d650
Bump y18n from 4.0.0 to 4.0.3 in /examples/ssr-next (#1255)
dependabot[bot] Jul 14, 2021
72ee3ee
fix deselect/select on multiple select menus, optimize perf, remove b…
Jul 14, 2021
87e5fba
rm unused ava tests (#1262)
Jul 15, 2021
41e7a8f
rm enzyme (#1263)
Jul 16, 2021
a8288d0
Upgrade deps (#1261)
Jul 16, 2021
4db6667
update ssr example dir (#1266)
Jul 16, 2021
952ad21
Bump css-what from 5.0.0 to 5.0.1 (#1264)
dependabot[bot] Jul 17, 2021
6d03cc4
fix Transition nodeRef in Positioner component (#1271)
Jul 17, 2021
fc3ad76
update node engine to 12+, move react-is to peerDep matching react ve…
Jul 18, 2021
8cb9e95
chore: upgrade rollup (#1068)
g1eny0ung Jul 22, 2021
965735a
Performance tuning (#1274)
Jul 22, 2021
e96f05b
include ReactIs as global since it needs to be a peer dep
mshwery Jul 22, 2021
e656505
v6.2.0-0
mshwery Jul 22, 2021
3911c25
v6.2.0
mshwery Jul 22, 2021
8c6347d
upgrade EG in the docs (#1278)
Jul 22, 2021
f6ade5f
remove css-nil classes from glamor (#1280)
Jul 28, 2021
432cfea
v6.2.1
mshwery Jul 29, 2021
082f7f8
React 17 support (#1281)
Jul 29, 2021
f1db5f8
v6.3.0
mshwery Jul 29, 2021
915c39d
Empty state fix (#1286)
kamebkj Aug 9, 2021
1d380c5
Use EvergreenLink for text link in doc (#1293)
kamebkj Aug 10, 2021
366bb39
v6.4.0
kamebkj Aug 11, 2021
674d9a1
Empty state doc (#1290)
kamebkj Aug 12, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
README updates for the main repo, and a light overview on the docs su…
…bdir (segmentio#1202)

* README updates for the main repo, and a light overview on the docs subdir

* One more fixup
  • Loading branch information
akleiner2 committed May 18, 2021
commit 23389eb5fb0bfb11e9a27d3ec333c7a02889e768
17 changes: 6 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@
- [Documentation](https://evergreen.segment.com/)
- [GitHub Discussions](https://github.com/segmentio/evergreen/discussions)

## Evergreen v4 to v5 Migration guide
## Evergreen v5 to v6 Migration guide

Evergreen v4 to v5 [migration guide](https://evergreen.segment.com/get-started/v5-migration-guide)
Evergreen v5 to v6 [migration guide](https://evergreen.segment.com/introduction/v6-migration-guide)

## Install and use components

Expand All @@ -42,10 +42,7 @@ import React from 'react'
import ReactDOM from 'react-dom'
import { Button } from 'evergreen-ui'

ReactDOM.render(
<Button>I am using 🌲 Evergreen!</Button>,
document.getElementById('root')
)
ReactDOM.render(<Button>I am using 🌲 Evergreen!</Button>, document.getElementById('root'))
```

## Core values of 🌲 Evergreen
Expand All @@ -61,9 +58,7 @@ ReactDOM.render(

### Theming support?

Evergreen v5 supports theming partially. It is still complex to theme Evergreen. We have done exploratory work to make theming more powerful and accessible, and hope to release a new theming api in Evergreen v6.

See these [docs](https://evergreen.segment.com/get-started/theming/) for more information regarding theming in Evergreen.
Evergreen supports a robust theming layer out of the box. You can check out [these docs](https://evergreen.segment.com/introduction/theming) for more information regarding theming in Evergreen.

### How does Server Side Rendering (SSR) work?

Expand Down Expand Up @@ -113,7 +108,7 @@ $ yarn install
$ yarn dev
```

Now you can visit `http:https://localhost:8000/` in your browser.
Now you can visit `http:https://localhost:3000/` in your browser.

Documentation code is under the `docs` directory. A big portion of these docs are written in MDX, if you've never used MDX before, check out these [docs](https://mdxjs.com/getting-started).

Expand Down Expand Up @@ -218,4 +213,4 @@ Please respect our [Code of Conduct](.github/CODE_OF_CONDUCT.md), in short:
Evergreen is released under the MIT license.
The BlueprintJS icons are licensed under a [custom Apache 2.0 license](https://github.com/palantir/blueprint/blob/develop/LICENSE).

Copyright © 2017 Segment.io, Inc.
Copyright © 2021 Segment.io, Inc.
44 changes: 15 additions & 29 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,27 @@
# TypeScript Next.js example
# Evergreen Docs

This is a really simple project that shows the usage of Next.js with TypeScript.
The following gives some information about getting the Evergreen docs site up and running locally.

## Deploy your own
# Spinning up the dev server

Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example):
To get started locally, run the following commands:

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-typescript&project-name=with-typescript&repository-name=with-typescript)

## How to use it?

Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:

```bash
npx create-next-app --example with-typescript with-typescript-app
# or
yarn create next-app --example with-typescript with-typescript-app
```
$ (docs): yarn install
$ (docs): yarn dev
```

Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).

## Notes

This example shows how to integrate the TypeScript type system into Next.js. Since TypeScript is supported out of the box with Next.js, all we have to do is to install TypeScript.
Then, navigate to your browser and go to: `localhost:3000`.

```
npm install --save-dev typescript
```
# Adding a new documentation page

To enable TypeScript's features, we install the type declarations for React and Node.
Add an entry under the corresponding header in `IA.ts` - you can think of this as the "database" for all status relating to Evergreen components and documentation.

```
npm install --save-dev @types/react @types/react-dom @types/node
```
From there, the directory structure in `docs/documentation/` contains the `.mdx` files which mirror the route structure for the docs site.

When we run `next dev` the next time, Next.js will start looking for any `.ts` or `.tsx` files in our project and builds it. It even automatically creates a `tsconfig.json` file for our project with the recommended settings.
Any thumbnail images or static assets should be added in the `public/` directory, as they'll be picked up by Next.js.

Next.js has built-in TypeScript declarations, so we'll get autocompletion for Next.js' modules straight away.
# A note about hot-reloading / fast-refresh

A `type-check` script is also added to `package.json`, which runs TypeScript's `tsc` CLI in `noEmit` mode to run type-checking separately. You can then include this, for example, in your `test` scripts.
Changes made to any of the UI components that make up `docs/` (i.e. anything with a `ts` or `tsx` extension) will be picked up by Next.js automatically.
However, if you make changes to any `.mdx`, you should refresh the page that you're looking at.