mohammedalabdali96 / docs

Documentation of ZEIT Now and other services

ZEIT Now Documentation

This is the public documentation for ZEIT Now and other related services.

You can view this documentation at ZEIT Docs.

What is ZEIT Now?

ZEIT Now is a cloud platform for serverless deployment. It enables developers to host websites and web services that deploy instantly, scale automatically, and require no supervision, all with minimal configuration.

What Does this Repository Contain?

This repository is broken down into several sections, these include:

• Components - a collection of reusable components to be used when creating documentation
• Documentation - the documentation for both ZEIT Now 1.0 and 2.0
• Guides - guides created to show how to use ZEIT Now 2.0 in a variety of ways
• Static Assets - the location for static assets, such as images, to be used in guides
• Code of Conduct - our Code of Conduct, adapted from the Contributor Covenant
• Contributing Guidelines - a guide on how to contribute to the ZEIT Now documentation

The above sections provide quick access to the most important parts of the repository, helping you navigate as easily as possible.

Running Locally

You can run the documentation site locally by cloning this repository, installing the dependencies with yarn, and finally running the development server with yarn dev.

How to Contribute

Contributing to the ZEIT Now documentation should be an enjoyable experience, as such we have created a set of contributing guidelines to help you do so.

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.

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.

Reporting Issues

We actively encourage our community to raise issues and provide feedback on areas of the ZEIT Now documentation that could be improved.

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.

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.

License

The ZEIT Now documentation is an open source project released under the MIT License.

The ZEIT Now documentation uses the emojis from Twemoji. Copyright 2020 Twitter, Inc and other contributors. Licensed under CC-BY 4.0.

Get In Touch

If you have any questions that are not covered by raising an issue then please get in touch with us by emailing [email protected]. There you will find both members of the community and staff who are happy to help answer questions on anything ZEIT related.