Skip to content

Commit 3a2d0e2

Browse files
author
Matthew Sweeney
authored
Move Platform to Top Level (#1423)
* move platform to top level * remove route from now.json * add correct redirect
1 parent 1e770bf commit 3a2d0e2

26 files changed

+96
-107
lines changed

.github/CODEOWNERS

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,13 @@ pages/docs/v2/build-step.mdx @leo @AndyBitz @TooTallNate @timothy
88
pages/docs/v2/custom-domains.mdx @anatrajkovska @javivelasco @mglagola @joecohens @timothyis @msweeneydev @coetry
99
pages/docs/v2/serverless-functions/ @leo @AndyBitz @TooTallNate @timothyis @msweeneydev @coetry
1010
pages/docs/v2/network/ @juancampa @hharnisc @dav-is @timothyis @msweeneydev @joecohens @coetry
11+
pages/docs/v2/platform/ @leo @styfle @timothyis @msweeneydev @joecohens @coetry
1112
pages/docs/v2/advanced/now-for-github.mdx @arunoda @timothyis @msweeneydev @coetry
1213
pages/docs/v2/advanced/now-for-gitlab.mdx @arunoda @timothyis @msweeneydev @coetry
13-
pages/docs/configuration @leo @styfle @AndyBitz @timothyis @msweeneydev @joecohens @coetry
14+
pages/docs/configuration @leo @styfle @AndyBitz @timothyis @msweeneydev @joecohens @coetry
1415
pages/docs/v2/advanced/deploy-hooks.mdx @anatrajkovska @javivelasco @mglagola @timothyis @msweeneydev @joecohens @coetry
1516
pages/docs/v2/advanced/builders.mdx @leo @AndyBitz @styfle @timothyis @msweeneydev @joecohens @coetry
16-
pages/docs/v2/advanced/concepts/ @leo @timothyis @msweeneydev @joecohens @coetry
1717
pages/docs/v2/advanced/domains/ @anatrajkovska @javivelasco @mglagola @timothyis @msweeneydev @joecohens @coetry
18-
pages/docs/v2/advanced/platform/ @leo @styfle @timothyis @msweeneydev @joecohens @coetry
1918
pages/docs/api/ @anatrajkovska @arunoda @javivelasco @mglagola @timothyis @msweeneydev @coetry
2019
pages/docs/integrations/ @arunoda @timothyis @msweeneydev @coetry
2120
pages/docs/error/ @juancampa @dav-is @timothyis @msweeneydev @joecohens @coetry

components/references-mdx/api/v2/api-basics/rate-limits.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ status "**429 Too Many Requests**":
3232

3333
<Note>
3434
You can find the complete list of rate limits in the{' '}
35-
<GenericLink href="/docs/v2/advanced/platform/limits/">
35+
<GenericLink href="/docs/v2/platform/limits/">
3636
limits documentation
3737
</GenericLink>
3838
.

components/references-mdx/configuration/configuration/configuration.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export const meta = {
2222

2323
The prefix for all new deployment instances. The CLI usually generates this field automatically based on the name of the directory. But if you'd like to define it explicitly, this is the way to go.
2424

25-
The defined name is also used to organize the deployment into [a project](/docs/v2/advanced/platform/projects).
25+
The defined name is also used to organize the deployment into [a project](/docs/v2/platform/projects).
2626

2727
<Code lang="json">{`{
2828
"name": "zeit-chat"
@@ -34,7 +34,7 @@ The defined name is also used to organize the deployment into [a project](/docs/
3434

3535
**Valid values**: `1`, `2`.
3636

37-
Specifies the [Now Platform version](/docs/v2/advanced/platform/overview#versioning) the deployment should use and is known to work with. We strongly recommend setting a `version` when working on production systems or using source control (e.g. [Git](https://git-scm.com)).
37+
Specifies the [Now Platform version](/docs/v2/platform/overview#versioning) the deployment should use and is known to work with. We strongly recommend setting a `version` when working on production systems or using source control (e.g. [Git](https://git-scm.com)).
3838

3939
<Code lang="json">{`{
4040
"version": 2
@@ -44,7 +44,7 @@ Specifies the [Now Platform version](/docs/v2/advanced/platform/overview#version
4444

4545
**Type**: `Array` or `String`.
4646

47-
**Valid values**: [domain names](/docs/v2/custom-domains) (optionally including subdomains) added to the account, or a string for a suffixed URL using `.now.sh` or a [Custom Deployment Suffix](/docs/v2/advanced/platform/add-ons/#custom-deployment-suffix).
47+
**Valid values**: [domain names](/docs/v2/custom-domains) (optionally including subdomains) added to the account, or a string for a suffixed URL using `.now.sh` or a [Custom Deployment Suffix](/docs/v2/platform/add-ons/#custom-deployment-suffix).
4848

4949
**Limit**: A maximum of 64 aliases in the array
5050

@@ -71,7 +71,7 @@ You can deploy to the defined aliases using [Now CLI](/download) by setting the
7171

7272
**Valid values**: For teams, either an ID or slug. For users, either a email address, username, or ID.
7373

74-
This property determines the scope ([user or team](/docs/v2/advanced/platform/users-and-teams/)) under which the project will be deployed by [Now CLI](/download).
74+
This property determines the scope ([user or team](/docs/v2/platform/users-and-teams/)) under which the project will be deployed by [Now CLI](/download).
7575

7676
Furthermore, it also affects any other actions that the user takes within the directory that contains this configuration (e.g. listing [secrets](/docs/v2/serverless-functions/env-and-secrets/) using `now secrets ls`).
7777

@@ -224,7 +224,7 @@ For more information on routes, see the documentation:
224224

225225
**Type:** `Array` of region identifier `String`.
226226

227-
**Valid values:** a list of valid [region identifiers](/docs/v2/advanced/platform/regions-and-providers).
227+
**Valid values:** a list of valid [region identifiers](/docs/v2/platform/regions-and-providers).
228228

229229
By setting and modifying this value, you can decide the deployment **regions** of the [Serverless Functions](/docs/v2/serverless-functions/introduction/) that get created as a result of the [build steps](/docs/v2/build-step). By default, the closest region to the geographical location of the deployment is used, or if using a Now for Git integration, SFO is used by default.
230230

@@ -247,7 +247,7 @@ The special value `all` can be used to target all available regions.
247247

248248
**Type**: `Boolean`.
249249

250-
When set to `true`, both the [source view](/docs/v2/advanced/platform/deployments/#source-view) and [logs view](/docs/v2/advanced/platform/deployments/#logs-view) will be publicly accessible (when the user is authenticated with ZEIT).
250+
When set to `true`, both the [source view](/docs/v2/platform/deployments/#source-view) and [logs view](/docs/v2/platform/deployments/#logs-view) will be publicly accessible (when the user is authenticated with ZEIT).
251251

252252
<Code lang="json">{`{
253253
"public": true

components/references-mdx/now-cli/commands/remove.mdx

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,9 @@ The `now remove` command, which can be shortened to `now rm`, is used to remove
3434

3535
<Note type="warning">
3636
By using the{' '}
37-
<GenericLink href="/docs/v2/advanced/platform/projects/">
38-
project name
39-
</GenericLink>
40-
, the entire project will be removed from the account unless the <InlineCode>
41-
--safe
42-
</InlineCode> is used.
37+
<GenericLink href="/docs/v2/platform/projects/">project name</GenericLink>,
38+
the entire project will be removed from the account unless the{' '}
39+
<InlineCode>--safe</InlineCode> is used.
4340
</Note>
4441

4542
### Global Options

components/references-mdx/now-cli/commands/teams.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ export const meta = {
1010

1111
## Teams
1212

13-
The `now teams` command is used to manage [teams](/docs/v2/advanced/platform/users-and-teams/) under an account, providing functionality to list, add, and invite new members to teams.
13+
The `now teams` command is used to manage [teams](/docs/v2/platform/users-and-teams/) under an account, providing functionality to list, add, and invite new members to teams.
1414

1515
<Note type="warning">
1616
This command is for <b>advanced use only</b>. You can manage teams with

lib/data/guides.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,6 @@
391391
"authors": ["msweeneydev"],
392392
"url": "/guides/zero-downtime-domain-migration",
393393
"editUrl": "pages/guides/zero-downtime-domain-migration.mdx",
394-
"lastEdited": "2019-10-02T14:07:07.000Z"
394+
"lastEdited": "2019-10-30T09:43:23.000Z"
395395
}
396396
]

lib/data/v2/docs.js

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,39 @@ export default [
4141
}
4242
]
4343
},
44+
{
45+
name: 'Platform',
46+
posts: [
47+
{
48+
name: 'Overview',
49+
href: '/docs/v2/platform/overview'
50+
},
51+
{
52+
name: 'Deployments',
53+
href: '/docs/v2/platform/deployments'
54+
},
55+
{
56+
name: 'Projects',
57+
href: '/docs/v2/platform/projects'
58+
},
59+
{
60+
name: 'Users and Teams',
61+
href: '/docs/v2/platform/users-and-teams'
62+
},
63+
{
64+
name: 'Limits',
65+
href: '/docs/v2/platform/limits'
66+
},
67+
{
68+
name: 'Glossary',
69+
href: '/docs/v2/platform/glossary'
70+
},
71+
{
72+
name: 'Frequently Asked Questions',
73+
href: '/docs/v2/platform/frequently-asked-questions'
74+
}
75+
]
76+
},
4477
{
4578
name: 'Network',
4679
posts: [
@@ -96,39 +129,6 @@ export default [
96129
{
97130
name: 'Deploy Hooks',
98131
href: '/docs/v2/advanced/deploy-hooks'
99-
},
100-
{
101-
name: 'Platform',
102-
posts: [
103-
{
104-
name: 'Overview',
105-
href: '/docs/v2/advanced/platform/overview'
106-
},
107-
{
108-
name: 'Deployments',
109-
href: '/docs/v2/advanced/platform/deployments'
110-
},
111-
{
112-
name: 'Projects',
113-
href: '/docs/v2/advanced/platform/projects'
114-
},
115-
{
116-
name: 'Users and Teams',
117-
href: '/docs/v2/advanced/platform/users-and-teams'
118-
},
119-
{
120-
name: 'Limits',
121-
href: '/docs/v2/advanced/platform/limits'
122-
},
123-
{
124-
name: 'Glossary',
125-
href: '/docs/v2/advanced/platform/glossary'
126-
},
127-
{
128-
name: 'Frequently Asked Questions',
129-
href: '/docs/v2/advanced/platform/frequently-asked-questions'
130-
}
131-
]
132132
}
133133
]
134134
}

now.json

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -226,9 +226,9 @@
226226
"headers": { "Location": "/docs/configuration#global" }
227227
},
228228
{
229-
"src": "/docs/v2/platform/(.*)/?",
229+
"src": "/docs/v2/advanced/platform/(.*)/?",
230230
"status": 301,
231-
"headers": { "Location": "/docs/v2/advanced/platform/$1" }
231+
"headers": { "Location": "/docs/v2/platform/$1" }
232232
},
233233
{
234234
"src": "/docs/v2/development/basic/(.*)/?",
@@ -253,14 +253,7 @@
253253
"src": "/docs/version-detection",
254254
"status": 301,
255255
"headers": {
256-
"Location": "/docs/v2/advanced/platform/frequently-asked-questions#platform-version-detection"
257-
}
258-
},
259-
{
260-
"src": "/docs/v2/advanced/concepts/lambdas(.*)",
261-
"status": 301,
262-
"headers": {
263-
"Location": "/docs/v2/advanced/concepts/serverless-functions$1"
256+
"Location": "/docs/v2/platform/frequently-asked-questions#platform-version-detection"
264257
}
265258
}
266259
]

pages/docs/error/application/BODY_NOT_A_STRING_FROM_FUNCTION.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ export const meta = {
66
title: 'Body Not A String From Serverless Function',
77
description: 'The Serverless Function did not respond with a string.',
88
editUrl: 'pages/docs/error/application/BODY_NOT_A_STRING_FROM_FUNCTION.mdx',
9-
lastEdited: '2019-10-22T21:47:59.000Z'
9+
lastEdited: '2019-10-30T09:43:23.000Z'
1010
}
1111

1212
#### Application Error
@@ -27,7 +27,7 @@ This is an error with the application.
2727

2828
#### Troubleshoot
2929

30-
- Check the application logs, which can be found at the host URL under [the `/_logs` path](/docs/v2/advanced/platform/deployments/#logs-view), for example:
30+
- Check the application logs, which can be found at the host URL under [the `/_logs` path](/docs/v2/platform/deployments/#logs-view), for example:
3131
```
3232
https://my-deployment-lwbxweoqjo.now.sh/_logs
3333
```

pages/docs/error/application/FUNCTION_INVOCATION_TIMEOUT.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ export const meta = {
77
description:
88
'The requested Serverless Function reached the request timeout threshold.',
99
editUrl: 'pages/docs/error/application/FUNCTION_INVOCATION_TIMEOUT.mdx',
10-
lastEdited: '2019-10-22T21:47:59.000Z'
10+
lastEdited: '2019-10-30T09:43:23.000Z'
1111
}
1212

1313
#### Application Error
@@ -26,7 +26,7 @@ The request for a Serverless Function reached the timeout threshold (5 minutes f
2626

2727
#### Troubleshoot
2828

29-
- A common cause for this issue is when the application contains an unhandled exception. Check the application logs, which can be found at the host URL under [the `/_logs` path](/docs/v2/advanced/platform/deployments/#logs-view), for example:
29+
- A common cause for this issue is when the application contains an unhandled exception. Check the application logs, which can be found at the host URL under [the `/_logs` path](/docs/v2/platform/deployments/#logs-view), for example:
3030
```
3131
https://my-deployment-lwbxweoqjo.now.sh/_logs
3232
```

pages/docs/error/application/NO_STATUS_CODE_FROM_FUNCTION.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ export const meta = {
77
description:
88
'The requested Serverless Function failed to respond with a status code.',
99
editUrl: 'pages/docs/error/application/NO_STATUS_CODE_FROM_FUNCTION.mdx',
10-
lastEdited: '2019-10-22T21:47:59.000Z'
10+
lastEdited: '2019-10-30T09:43:23.000Z'
1111
}
1212

1313
#### Application Error
@@ -27,7 +27,7 @@ The application did not respond with a status code.
2727
#### Troubleshoot
2828

2929
- Make sure the Serverless Function from the application responds with a status code.
30-
- Check the application logs, which can be found at the host URL under [the `/_logs` path](/docs/v2/advanced/platform/deployments/#logs-view), for example:
30+
- Check the application logs, which can be found at the host URL under [the `/_logs` path](/docs/v2/platform/deployments/#logs-view), for example:
3131
```
3232
https://my-deployment-lwbxweoqjo.now.sh/_logs
3333
```

pages/docs/v2/advanced/now-for-gitlab.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ export const meta = {
99
description:
1010
'Deploy each change in your GitLab projects with ZEIT Now to share and test with your colleagues. Instant share-able links to your work with each push. Automatically make your changes available from production domains.',
1111
editUrl: 'pages/docs/v2/advanced/now-for-gitlab.mdx',
12-
lastEdited: '2019-10-10T22:30:47.000Z'
12+
lastEdited: '2019-10-30T09:43:23.000Z'
1313
}
1414

1515
The Now for GitLab integration automatically deploys your GitLab projects with [ZEIT Now](/now), providing staging URLs and automatic production domain updates.
@@ -31,7 +31,7 @@ Now for GitLab provides:
3131

3232
### Step 1: Link ZEIT Now to Your GitLab Account
3333

34-
You can connect your Now account to GitLab by visiting your [account or team](/docs/v2/advanced/platform/users-and-teams) [settings page](/account) and clicking the "Connect with GitLab" button.
34+
You can connect your Now account to GitLab by visiting your [account or team](/docs/v2/platform/users-and-teams) [settings page](/account) and clicking the "Connect with GitLab" button.
3535

3636
<Image
3737
src={`${process.env.ASSETS}/docs/now-for-gitlab/connect-with-gitlab.png`}

pages/docs/v2/build-step.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ If you change the value of a [Now Secret](#adding-secrets) or environment variab
156156

157157
### Reserved Variables
158158

159-
The ZEIT Now platform reserves the usage of some environment variable names by default. You can find a list of these names in the [limits documentation](/docs/v2/advanced/platform/limits/#reserved-variables).
159+
The ZEIT Now platform reserves the usage of some environment variable names by default. You can find a list of these names in the [limits documentation](/docs/v2/platform/limits/#reserved-variables).
160160

161161
## Ignored Files and Folders
162162

pages/docs/v2/environment-variables-and-secrets.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ export const meta = {
99
description:
1010
'Creating and using environment variables and creating and using secret environment variables in your ZEIT Now deployments',
1111
editUrl: 'pages/docs/v2/environment-variables-and-secrets.mdx',
12-
lastEdited: '2019-10-22T21:51:28.000Z'
12+
lastEdited: '2019-10-30T09:43:23.000Z'
1313
}
1414

1515
If there's information or certain behavior of your project that needs to differ depending on if it's running locally or on ZEIT Now, environment variables offer the perfect solution.
@@ -105,7 +105,7 @@ The syntax required to make the environment variable available inside the build
105105

106106
### Built-In Variables
107107

108-
By default, all deployments expose the `NOW_REGION` environment variable to [Serverless Functions](/docs/v2/serverless-functions/introduction/) which provides the [region](/docs/v2/advanced/platform/regions-and-providers/) that the lambda was deployed to.
108+
By default, all deployments expose the `NOW_REGION` environment variable to [Serverless Functions](/docs/v2/serverless-functions/introduction/) which provides the [region](/docs/v2/platform/regions-and-providers/) that the lambda was deployed to.
109109

110110
### Reserved Variables
111111

pages/docs/v2/network/headers.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ export const meta = {
66
title: 'Headers',
77
description: 'The list of headers included with deployments with ZEIT Now.',
88
editUrl: 'pages/docs/v2/network/headers.mdx',
9-
lastEdited: '2019-10-22T21:51:28.000Z'
9+
lastEdited: '2019-10-30T09:43:23.000Z'
1010
}
1111

1212
[HTTP headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers) can be found in both the HTTP Request and HTTP Response.
@@ -41,7 +41,7 @@ This header represents the unique deployment, not the staging or production doma
4141

4242
### `x-now-trace`
4343

44-
Contains a list of [regions](/docs/v2/advanced/platform/regions-and-providers/) through which the request has traversed, usually the region closest to the visitor.
44+
Contains a list of [regions](/docs/v2/platform/regions-and-providers/) through which the request has traversed, usually the region closest to the visitor.
4545

4646
<Note>
4747
The trace is where a request was processed, it is not necessarily where a
@@ -106,7 +106,7 @@ The unique identifier for each request.
106106

107107
### `x-now-trace`
108108

109-
Contains a list of [regions](/docs/v2/advanced/platform/regions-and-providers/) through which the request has traversed, usually the region center closest to you.
109+
Contains a list of [regions](/docs/v2/platform/regions-and-providers/) through which the request has traversed, usually the region center closest to you.
110110

111111
<Note>
112112
The trace is where a request was processed, it is not necessarily where a

0 commit comments

Comments
 (0)