diff options
author | Fred Carlsen <fred@sjelfull.no> | 2018-11-27 23:19:36 +0800 |
---|---|---|
committer | Fred Carlsen <fred@sjelfull.no> | 2018-11-27 23:19:36 +0800 |
commit | 9b0020a884bdb98f9da434878fec171ab533ba7e (patch) | |
tree | ca285eb7dfd2c68f781b8b74d409fb69665a58dc /packages/website | |
parent | ec12e46e3f52ebb44338c113cecd073979821fae (diff) | |
parent | fdc4a4e5fa31d8797abf6313f4488147853ed77e (diff) | |
download | dexon-0x-contracts-9b0020a884bdb98f9da434878fec171ab533ba7e.tar dexon-0x-contracts-9b0020a884bdb98f9da434878fec171ab533ba7e.tar.gz dexon-0x-contracts-9b0020a884bdb98f9da434878fec171ab533ba7e.tar.bz2 dexon-0x-contracts-9b0020a884bdb98f9da434878fec171ab533ba7e.tar.lz dexon-0x-contracts-9b0020a884bdb98f9da434878fec171ab533ba7e.tar.xz dexon-0x-contracts-9b0020a884bdb98f9da434878fec171ab533ba7e.tar.zst dexon-0x-contracts-9b0020a884bdb98f9da434878fec171ab533ba7e.zip |
Merge remote-tracking branch 'upstream/development' into website
Diffstat (limited to 'packages/website')
-rw-r--r-- | packages/website/md/docs/migrations/1/installation.md | 17 | ||||
-rw-r--r-- | packages/website/md/docs/migrations/1/introduction.md | 1 | ||||
-rw-r--r-- | packages/website/package.json | 20 | ||||
-rw-r--r-- | packages/website/public/images/team/xianny.png | bin | 0 -> 49783 bytes | |||
-rw-r--r-- | packages/website/ts/containers/migrations_documentation.ts | 66 | ||||
-rw-r--r-- | packages/website/ts/index.tsx | 7 | ||||
-rw-r--r-- | packages/website/ts/pages/about/about.tsx | 8 | ||||
-rw-r--r-- | packages/website/ts/pages/documentation/doc_page.tsx | 1 | ||||
-rw-r--r-- | packages/website/ts/pages/documentation/docs_home.tsx | 25 | ||||
-rw-r--r-- | packages/website/ts/types.ts | 2 |
10 files changed, 137 insertions, 10 deletions
diff --git a/packages/website/md/docs/migrations/1/installation.md b/packages/website/md/docs/migrations/1/installation.md new file mode 100644 index 000000000..78403037b --- /dev/null +++ b/packages/website/md/docs/migrations/1/installation.md @@ -0,0 +1,17 @@ +**Install** + +```bash +yarn add @0x/migrations +``` + +**Import** + +```javascript +import { runMigrationsAsync } from '@0x/migrations'; +``` + +or + +```javascript +var runMigrationsAsync = require('@0x/migrations').runMigrationsAsync; +``` diff --git a/packages/website/md/docs/migrations/1/introduction.md b/packages/website/md/docs/migrations/1/introduction.md new file mode 100644 index 000000000..82ae3a0ab --- /dev/null +++ b/packages/website/md/docs/migrations/1/introduction.md @@ -0,0 +1 @@ +Welcome to the [@0x/migrations](https://github.com/0xProject/0x-monorepo/tree/development/packages/migrations) documentation! This package is intended for developers who would like to deploy the 0x protocol system of smart contracts to a custom testnet. If you want to test against existing testnets, check out our pre-deployed [Ganache snapshot](https://0xproject.com/wiki#Ganache-Setup-Guide) or where 0x is already deployed on [popular testnets](https://0xproject.com/wiki#Deployed-Addresses). diff --git a/packages/website/package.json b/packages/website/package.json index bb64b24db..52ba206c6 100644 --- a/packages/website/package.json +++ b/packages/website/package.json @@ -1,6 +1,6 @@ { "name": "@0x/website", - "version": "0.0.59", + "version": "0.0.60", "engines": { "node": ">=6.12" }, @@ -20,16 +20,16 @@ "author": "Fabio Berger", "license": "Apache-2.0", "dependencies": { - "@0x/contract-wrappers": "^4.0.2", - "@0x/json-schemas": "^2.1.1", - "@0x/order-utils": "^3.0.2", - "@0x/react-docs": "^1.0.18", - "@0x/react-shared": "^1.0.21", - "@0x/subproviders": "^2.1.4", - "@0x/types": "^1.2.1", + "@0x/contract-wrappers": "^4.1.0", + "@0x/json-schemas": "^2.1.2", + "@0x/order-utils": "^3.0.3", + "@0x/react-docs": "^1.0.19", + "@0x/react-shared": "^1.0.22", + "@0x/subproviders": "^2.1.5", + "@0x/types": "^1.3.0", "@0x/typescript-typings": "^3.0.4", - "@0x/utils": "^2.0.5", - "@0x/web3-wrapper": "^3.1.4", + "@0x/utils": "^2.0.6", + "@0x/web3-wrapper": "^3.1.5", "accounting": "^0.4.1", "basscss": "^8.0.3", "blockies": "^0.0.2", diff --git a/packages/website/public/images/team/xianny.png b/packages/website/public/images/team/xianny.png Binary files differnew file mode 100644 index 000000000..f6fe1ef61 --- /dev/null +++ b/packages/website/public/images/team/xianny.png diff --git a/packages/website/ts/containers/migrations_documentation.ts b/packages/website/ts/containers/migrations_documentation.ts new file mode 100644 index 000000000..02919e06e --- /dev/null +++ b/packages/website/ts/containers/migrations_documentation.ts @@ -0,0 +1,66 @@ +import { DocsInfo, DocsInfoConfig, SupportedDocJson } from '@0x/react-docs'; +import * as React from 'react'; +import { connect } from 'react-redux'; +import { Dispatch } from 'redux'; +import { DocPage as DocPageComponent, DocPageProps } from 'ts/pages/documentation/doc_page'; +import { Dispatcher } from 'ts/redux/dispatcher'; +import { State } from 'ts/redux/reducer'; +import { DocPackages, ScreenWidths } from 'ts/types'; +import { Translate } from 'ts/utils/translate'; + +/* tslint:disable:no-var-requires */ +const IntroMarkdown1 = require('md/docs/migrations/1/introduction'); +const InstallationMarkdown1 = require('md/docs/migrations/1/installation'); +/* tslint:enable:no-var-requires */ + +const markdownSections = { + introduction: 'introduction', + installation: 'installation', +}; + +const docsInfoConfig: DocsInfoConfig = { + id: DocPackages.Migrations, + packageName: '@0x/migrations', + type: SupportedDocJson.TypeDoc, + displayName: 'Migrations', + packageUrl: 'https://github.com/0xProject/0x-monorepo', + markdownMenu: { + 'getting-started': [markdownSections.introduction, markdownSections.installation], + }, + sectionNameToMarkdownByVersion: { + '2.0.4': { + [markdownSections.introduction]: IntroMarkdown1, + [markdownSections.installation]: InstallationMarkdown1, + }, + }, + markdownSections, +}; +const docsInfo = new DocsInfo(docsInfoConfig); + +interface ConnectedState { + docsVersion: string; + availableDocVersions: string[]; + docsInfo: DocsInfo; + translate: Translate; + screenWidth: ScreenWidths; +} + +interface ConnectedDispatch { + dispatcher: Dispatcher; +} + +const mapStateToProps = (state: State, _ownProps: DocPageProps): ConnectedState => ({ + docsVersion: state.docsVersion, + availableDocVersions: state.availableDocVersions, + translate: state.translate, + docsInfo, + screenWidth: state.screenWidth, +}); + +const mapDispatchToProps = (dispatch: Dispatch<State>): ConnectedDispatch => ({ + dispatcher: new Dispatcher(dispatch), +}); + +export const Documentation: React.ComponentClass<DocPageProps> = connect(mapStateToProps, mapDispatchToProps)( + DocPageComponent, +); diff --git a/packages/website/ts/index.tsx b/packages/website/ts/index.tsx index 96e7184f8..faf7d8c87 100644 --- a/packages/website/ts/index.tsx +++ b/packages/website/ts/index.tsx @@ -40,6 +40,9 @@ const LazyZeroExJSDocumentation = createLazyComponent('Documentation', async () const LazyContractWrappersDocumentation = createLazyComponent('Documentation', async () => import(/* webpackChunkName: "contractWrapperDocs" */ 'ts/containers/contract_wrappers_documentation'), ); +const LazyMigrationsDocumentation = createLazyComponent('Documentation', async () => + import(/* webpackChunkName: "migrationsDocs" */ 'ts/containers/migrations_documentation'), +); const LazyOrderWatcherDocumentation = createLazyComponent('Documentation', async () => import(/* webpackChunkName: "orderWatcherDocs" */ 'ts/containers/order_watcher_documentation'), ); @@ -103,6 +106,10 @@ render( component={LazyContractWrappersDocumentation} /> <Route + path={`${WebsitePaths.Migrations}/:version?`} + component={LazyMigrationsDocumentation} + /> + <Route path={`${WebsitePaths.OrderWatcher}/:version?`} component={LazyOrderWatcherDocumentation} /> diff --git a/packages/website/ts/pages/about/about.tsx b/packages/website/ts/pages/about/about.tsx index dfe8926b0..81a3f59e1 100644 --- a/packages/website/ts/pages/about/about.tsx +++ b/packages/website/ts/pages/about/about.tsx @@ -248,6 +248,14 @@ const teamRow9: ProfileInfo[] = [ linkedIn: 'https://www.linkedin.com/in/steveklebanoff/', github: 'https://github.com/steveklebanoff', }, + { + name: 'Xianny Ng', + title: 'Engineer', + description: `Developer Experience. Previously telemetry at Mapbox and platform engineering at Bench Accounting.`, + image: 'images/team/xianny.png', + linkedIn: 'https://www.linkedin.com/in/xianny/', + github: 'https://github.com/xianny', + }, ]; const advisors1: ProfileInfo[] = [ diff --git a/packages/website/ts/pages/documentation/doc_page.tsx b/packages/website/ts/pages/documentation/doc_page.tsx index adf2261b5..3ae071774 100644 --- a/packages/website/ts/pages/documentation/doc_page.tsx +++ b/packages/website/ts/pages/documentation/doc_page.tsx @@ -39,6 +39,7 @@ const docIdToSubpackageName: { [id: string]: string } = { [DocPackages.OrderWatcher]: 'order-watcher', [DocPackages.EthereumTypes]: 'ethereum-types', [DocPackages.AssetBuyer]: 'asset-buyer', + [DocPackages.Migrations]: 'migrations', }; export interface DocPageProps { diff --git a/packages/website/ts/pages/documentation/docs_home.tsx b/packages/website/ts/pages/documentation/docs_home.tsx index e3328f3fa..f68d2892f 100644 --- a/packages/website/ts/pages/documentation/docs_home.tsx +++ b/packages/website/ts/pages/documentation/docs_home.tsx @@ -109,6 +109,14 @@ const CATEGORY_TO_PACKAGES: ObjectMap<Package[]> = { }, { description: + "A package to deploy the 0x protocol's system of smart contracts to the testnet of your choice", + link: { + title: '@0x/migrations', + to: WebsitePaths.Migrations, + }, + }, + { + description: 'A collection of 0x-related JSON-schemas (incl. SRA request/response schemas, 0x order message format schema, etc...)', link: { title: '@0x/json-schemas', @@ -133,6 +141,23 @@ const CATEGORY_TO_PACKAGES: ObjectMap<Package[]> = { }, { description: + 'A tiny utility library for getting known deployed contract addresses for a particular network.', + link: { + title: '@0x/contract-addresses', + to: 'https://www.npmjs.com/package/@0x/contract-addresses', + shouldOpenInNewTab: true, + }, + }, + { + description: 'Smart contract compilation artifacts for the latest version of the 0x protocol.', + link: { + title: '@0x/contract-artifacts', + to: 'https://www.npmjs.com/package/@0x/contract-artifacts', + shouldOpenInNewTab: true, + }, + }, + { + description: 'Contains the Standard Relayer API OpenAPI Spec. The package distributes both a javascript object version and a json version.', link: { title: '@0x/sra-spec', diff --git a/packages/website/ts/types.ts b/packages/website/ts/types.ts index 444a8348d..89c477085 100644 --- a/packages/website/ts/types.ts +++ b/packages/website/ts/types.ts @@ -366,6 +366,7 @@ export enum WebsitePaths { OrderUtils = '/docs/order-utils', EthereumTypes = '/docs/ethereum-types', AssetBuyer = '/docs/asset-buyer', + Migrations = '/docs/migrations', Careers = '/careers', } @@ -383,6 +384,7 @@ export enum DocPackages { ContractWrappers = 'CONTRACT_WRAPPERS', OrderWatcher = 'ORDER_WATCHER', AssetBuyer = 'ASSET_BUYER', + Migrations = 'MIGRATIONS', } export enum Key { |