You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+15-15
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,15 @@
1
-
# Contributing to the ZEIT Documentation
1
+
# Contributing to the Vercel Documentation
2
2
3
-
Thank you for your interest in contributing to the ZEIT Docs!
3
+
Thank you for your interest in contributing to the Vercel Docs!
4
4
5
-
The following describes how to contribute to the ZEIT documentation, API reference, guides and code examples.
5
+
The following describes how to contribute to the Vercel documentation, API reference, guides and code examples.
6
6
7
7
## What Does this Document Contain?
8
8
9
-
This document contains all the required information and links to resources needed to contribute to the ZEIT documentation:
9
+
This document contains all the required information and links to resources needed to contribute to the Vercel documentation:
10
10
11
11
-[Code of Conduct](#code-of-conduct) - our Code of Conduct, adapted from the [Contributor Covenant](http://contributor-covenant.org)
12
-
-[Reporting an Issue](#reporting-issues) - guidance on how to raise an issue or provide feedback on the ZEIT documentation
12
+
-[Reporting an Issue](#reporting-issues) - guidance on how to raise an issue or provide feedback on the Vercel documentation
13
13
-[Contributing Content](#contributing-content) - a collection of all information required for contributing
14
14
-[Forking Workflow](#forking-workflow) - a guide on how to keep your fork in sync with `master`
15
15
-[Platform and Usage Documentation](#platform-and-usage-documentation) - information on contributing to `pages/docs`
@@ -28,15 +28,15 @@ available at [http://contributor-covenant.org/version/1/4](http://contributor-co
28
28
29
29
## Reporting Issues
30
30
31
-
If you have found a bug, spelling mistake, missing information, or anything related to the ZEIT documentation that you feel is an issue that should be reported, please create a new issue here on GitHub. For issues relating to examples, please [create an issue on the ZEIT Now repository](https://github.com/zeit/now/issues/new).
31
+
If you have found a bug, spelling mistake, missing information, or anything related to the Vercel documentation that you feel is an issue that should be reported, please create a new issue here on GitHub. For issues relating to examples, please [create an issue on the Vercel repository](https://github.com/zeit/now/issues/new).
32
32
33
33
An issue can be raised by clicking the 'Issues' tab at the top of the repository, followed by the Green 'New issue' button. To make this process as easy as possible we have created a few basic templates to choose from, there are, however, often cases that will fall outside of the templates provided.
34
34
35
35
If your issue doesn't fit with any of the templates then that's okay, please submit it as a 'Documentation Issue or Request'. When submitting an issue, please thoroughly and concisely describe the problem you are experiencing so that we may easily understand and resolve the issue in a timely manner.
36
36
37
37
## Contributing Content
38
38
39
-
There are multiple sections of the ZEIT Docs, including: the main [ZEIT platform and usage documentation](https://zeit.co/docs), [guides](https://zeit.co/guides), [ZEIT API reference](https://zeit.co/docs/api), and [examples](https://zeit.co/examples).
39
+
There are multiple sections of the Vercel Docs, including: the main [Vercel platform and usage documentation](https://vercel.com/docs), [guides](https://vercel.com/guides), [Vercel API reference](https://vercel.com/docs/api), and [examples](https://vercel.com/examples).
40
40
41
41
When contributing content to any of the previously mentioned sections, please fork this repository and then edit the content for the section that you want to contribute to, if you are not sure how to do this then please take a look at the [Forking Workflow](#forking-workflow) below.
42
42
@@ -98,7 +98,7 @@ To the right of the branch you will see a button that says 'New pull request', c
98
98
- Your reason for making them
99
99
- A request for feedback if required (add [WIP] to your title)
100
100
101
-
Congratulations, you've just made your first pull request to the ZEIT Documentation!
101
+
Congratulations, you've just made your first pull request to the Vercel Documentation!
102
102
103
103
The rest of this section relates to other scenarios you may encounter whilst contributing and may not be applicable just yet, so feel free to [read ahead](#platform-and-usage-documentation). If you want to know what you should do in the event changes are requested to your pull request, or your master branch becomes out of sync with the official repository, read on below:
104
104
@@ -124,11 +124,11 @@ All you need to do is make the changes on the same branch locally, commit and pu
124
124
125
125
## Platform and Usage Documentation
126
126
127
-
The content for this section can be found in the `pages/docs` directory, under its respective version tag. The latest documentation for ZEIT Now 2.0 can be found within the `pages/docs/v2` directory.
127
+
The content for this section can be found in the `pages/docs` directory.
128
128
129
-
Each `.mdx` file within the docs directory, aside from the API files, is an independent page; as [enabled by Next.js](https://nextjs.org/docs/#configuring-extensions-looked-for-when-resolving-pages-in-pages). You can edit existing files or create a new file under the section the content belongs to.
129
+
Each `.mdx` file within the docs directory, aside from the API files, is an independent page. You can edit existing files or create a new file under the section the content belongs to.
130
130
131
-
As suggested by the `.mdx` extension, the ZEIT documentation uses [MDX](https://mdxjs.com), a markdown parser mixed with JSX. This allows us to use React components within markdown to nicely render our content.
131
+
As suggested by the `.mdx` extension, the Vercel documentation uses [MDX](https://mdxjs.com), a markdown parser mixed with JSX. This allows us to use React components within markdown to nicely render our content.
132
132
133
133
An example of a docs MDX file:
134
134
@@ -159,9 +159,9 @@ When adding a new page to the v2 docs, make sure to add it to the appropriate se
159
159
The content for this section can be found in the `pages/guides` directory.
160
160
Just like [Platform and Usage Docs](#platform-and-usage-documentation), our Guides use the same MDX system to generate top-level pages.
161
161
162
-
A guide can be written on many topics and will commonly focus on the creation and deployment of a project using ZEIT Now. We strongly encourage you to take a look at the existing guides, these illustrate the right level of detail required for each step, from initial creation through to deployment.
162
+
A guide can be written on many topics and will commonly focus on the creation and deployment of a project using Vercel. We strongly encourage you to take a look at the existing guides, these illustrate the right level of detail required for each step, from initial creation through to deployment.
163
163
164
-
Guides are not limited to project creation and deployment however. The ZEIT Now platform is incredibly powerful and feature-rich, as a result there are many topics you could contribute to, our advice would be to take a feature you enjoy and use that as a starting point for your guide.
164
+
Guides are not limited to project creation and deployment however. The Vercel platform is incredibly powerful and feature-rich, as a result there are many topics you could contribute to, our advice would be to take a feature you enjoy and use that as a starting point for your guide.
165
165
166
166
An example of a guides MDX file:
167
167
@@ -195,7 +195,7 @@ When adding a new guide, make sure to import and export the meta of the guide in
195
195
196
196
The content for this section can be found in the `pages/docs/api` directory. It uses the same versioning structure as `pages/docs`.
197
197
198
-
We are currently focused on expanding the documentation for the ZEIT Now platform 2.0 API reference which can be found in `pages/docs/api/v2`.
198
+
We are currently focused on expanding the documentation for the Vercel platform 2.0 API reference which can be found in `pages/docs/api/v2`.
199
199
200
200
As with the [Platform and Usage Docs](#platform-and-usage-documentation), the API uses MDX, although each file is not an independent page but instead is compiled into a single page, listing the file in the `lib/data/v2/api.js` file.
201
201
@@ -219,6 +219,6 @@ We believe that these components should be enough to cover usage in nearly all s
219
219
220
220
A picture is worth a thousand words. Using graphics such as images in guides and documentation can really help the reader understand new concepts, if you'd like to include images, or any other static asset, you should follow this advice.
221
221
222
-
All static assets should be filed under `public/static` along with their type, docs or guide, and if specific to a particular page, the name of that page. For example, `public/static/guides/deploying-angular-with-now` would be the place to store static assets for a guide on deploying Angular with ZEIT Now.
222
+
All static assets should be filed under `public/static` along with their type, docs or guide, and if specific to a particular page, the name of that page. For example, `public/static/guides/deploying-angular-with-now` would be the place to store static assets for a guide on deploying Angular with Vercel.
223
223
224
224
By following this convention, you will be helping us keep this repository organized and easy to find things within, making life easier for everyone.
This is the public documentation for **ZEIT Now** and other related services.
3
+
This is the public documentation for **Vercel** and other related services.
4
4
5
-
You can view this documentation at [ZEIT Docs](https://zeit.co/docs).
5
+
You can view this documentation at https://vercel.com/docs.
6
6
7
-
## What is ZEIT Now?
7
+
## What is Vercel?
8
8
9
-
ZEIT Now is a cloud platform for serverless deployment. It enables developers to host Jamstack websites and web services that deploy instantly, scale automatically, and require no supervision, all with minimal configuration.
9
+
Vercel is a cloud platform for serverless deployment. It enables developers to host Jamstack websites and web services that deploy instantly, scale automatically, and require no supervision, all with minimal configuration.
10
10
11
11
## What Does this Repository Contain?
12
12
13
13
This repository is broken down into several sections, these include:
14
14
15
15
-[Components](https://github.com/zeit/docs/tree/master/components) - a collection of reusable components to be used when creating documentation
16
-
-[Documentation](https://github.com/zeit/docs/tree/master/pages/docs) - the documentation for both ZEIT Now 1.0 and 2.0
17
-
-[Guides](https://github.com/zeit/docs/tree/master/pages/guides) - guides created to show how to use ZEIT Now 2.0 in a variety of ways
16
+
-[Documentation](https://github.com/zeit/docs/tree/master/pages/docs) - the documentation for Vercel
17
+
-[Guides](https://github.com/zeit/docs/tree/master/pages/guides) - guides created to show how to use Vercel in a variety of ways
18
18
-[Static Assets](https://github.com/zeit/docs/tree/master/public/static/guides) - the location for static assets, such as images, to be used in guides
19
19
-[Code of Conduct](https://github.com/zeit/docs/blob/master/CODE_OF_CONDUCT.md) - our Code of Conduct, adapted from the [Contributor Covenant](http://contributor-covenant.org)
20
-
-[Contributing Guidelines](https://github.com/zeit/docs/blob/master/CONTRIBUTING.md) - a guide on how to contribute to the ZEIT Now documentation
20
+
-[Contributing Guidelines](https://github.com/zeit/docs/blob/master/CONTRIBUTING.md) - a guide on how to contribute to the Vercel documentation
21
21
22
22
The above sections provide quick access to the most important parts of the repository, helping you navigate as easily as possible.
23
23
@@ -27,26 +27,26 @@ You can run the documentation site locally by cloning this repository, installin
27
27
28
28
## How to Contribute
29
29
30
-
Contributing to the ZEIT Now documentation should be an enjoyable experience, as such we have created a set of [contributing guidelines](https://github.com/zeit/docs/blob/master/CONTRIBUTING.md) to help you do so.
30
+
Contributing to the Vercel documentation should be an enjoyable experience, as such we have created a set of [contributing guidelines](https://github.com/zeit/docs/blob/master/CONTRIBUTING.md) to help you do so.
31
31
32
32
The guidelines cover important information such as the difference between documentation and guides, how to use the provided components and where to put static assets.
33
33
34
-
We have tried to make contributing to the ZEIT Now documentation as easy as possible, especially for those new to Open Source. If anything is unclear or you have any questions then please create an issue to discuss your contribution and how best to make it.
34
+
We have tried to make contributing to the Vercel documentation as easy as possible, especially for those new to Open Source. If anything is unclear or you have any questions then please create an issue to discuss your contribution and how best to make it.
35
35
36
36
## Reporting Issues
37
37
38
-
We actively encourage our community to raise issues and provide feedback on areas of the ZEIT Now documentation that could be improved.
38
+
We actively encourage our community to raise issues and provide feedback on areas of the Vercel documentation that could be improved.
39
39
40
40
An issue can be raised by clicking the 'Issues' tab at the top of the repository, followed by the Green 'New issue' button. To make this process as easy as possible we have created a few basic templates to choose from, there are, however, often cases that will fall outside of the templates provided.
41
41
42
42
If your issue doesn't fit with any of the templates then that's okay, please submit it as a 'Documentation Issue or Request'. When submitting an issue, please thoroughly and concisely describe the problem you are experiencing so that we may easily understand and resolve the issue in a timely manner.
43
43
44
44
## License
45
45
46
-
The ZEIT Now documentation is an open source project released under the [MIT License](https://github.com/zeit/docs/blob/master/LICENSE.md).
46
+
The Vercel documentation is an open source project released under the [MIT License](https://github.com/zeit/docs/blob/master/LICENSE.md).
47
47
48
-
The ZEIT Now documentation uses the emojis from [Twemoji](https://twemoji.twitter.com). Copyright 2020 Twitter, Inc and other contributors. Licensed under [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0).
48
+
The Vercel documentation uses the emojis from [Twemoji](https://twemoji.twitter.com). Copyright 2020 Twitter, Inc and other contributors. Licensed under [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0).
49
49
50
50
## Get In Touch
51
51
52
-
If you have any questions that are not covered by raising an issue then please get in touch with us by emailing support@zeit.co. There you will find both members of the community and staff who are happy to help answer questions on anything ZEIT related.
52
+
If you have any questions that are not covered by raising an issue then please get in touch with us by emailing support@vercel.com. There you will find both members of the community and staff who are happy to help answer questions on anything Vercel related.
@@ -366,7 +366,7 @@ This is equivalent to `npm install --only=production` or `yarn install --product
366
366
367
367
### Prevent Cache Usage
368
368
369
-
If you need to ignore the cache for a deployment, you can do so by using the [`-f` flag for <ProductShortName /> CLI](/docs/now-cli/#commands/now/global-options). This prevents the cache from being used in the deployment and ensures a fresh install for all dependencies.
369
+
If you need to ignore the cache for a deployment, you can do so by using the [`-f` flag for <ProductShortName /> CLI](/docs/now-cli/#commands/overview/global-options). This prevents the cache from being used in the deployment and ensures a fresh install for all dependencies.
0 commit comments