VSinerva/freesewing
1
0
Fork 0
Code Activity

fix(docs): Update Vercel documentation based on feedback

Browse source
This commit is contained in:
Benjamin F 2023-04-04 10:50:36 -07:00
parent 0633457366
commit c1757a6d46
1 changed files with 26 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

31
markdown/dev/tutorials/getting-started-vercel/en.md
View file

@ -20,6 +20,23 @@ This tutorial assumes that you already have a GitHub account
containing a fork of the FreeSewing repository. containing a fork of the FreeSewing repository.
</Note> </Note>
## Why you might want to use Vercel
There are reasons why you might want your own Vercel account:
- You can preview your changes:
- if you develop on a mobile device or if you do not have access to a
computer.
- without having to set up and maintain development environments on your
own computer.
- without having to manually rebuild your development environments each
time there is a code change.
- You can more easily share your work with others.
However, it is not necessary to have your own Vercel account.
Because we use Vercel to preview pull requests, if you always submit your
work to the main repository then you will be able to share your work without
needing to use Vercel yourself.
## About repositories, projects, and deployments ## About repositories, projects, and deployments
Vercel works through _repositories_, _projects_, and _deployments_. Vercel works through _repositories_, _projects_, and _deployments_.
@ -32,7 +49,7 @@ Within each repository there can be multiple projects.
_Projects_ are specific build types for the repository. _Projects_ are specific build types for the repository.
For example, one project in your FreeSewing repository could For example, one project in your FreeSewing repository could
be the one that builds the lab.freesewing.org website. be the one that builds the lab.freesewing.dev website.
You would use this project to test new designs or changes You would use this project to test new designs or changes
to existing designs. to existing designs.
Another project could be the one that builds the freesewing.org Another project could be the one that builds the freesewing.org
@ -143,12 +160,16 @@ website home page.
As mentioned previously, Vercel will eventually create and build many As mentioned previously, Vercel will eventually create and build many
deployments for your project. deployments for your project.
One is known as the _production deployment_, based on the `develop` branch One is known as the _production deployment_, based on the configured Production Branch of the repository (by default the branch named `main`).
of the repository. All other deployments are referred to as _preview deployments_, including
All other deployments are referred to as _preview deployments_. ones based on the `develop` branch
(unless you change the Production Branch in the Project Settings to
`develop` instead of `main).
Created deployments include: Created deployments include:
1. The initial production deployment for the `develop` branch 1. The initial production deployment. (Because you don't have a branch named
`main` in your repository, Vercel will instead create the initial
production deployment from the default `develop` branch.)
2. A new preview deployment every time you update your `develop` branch in GitHub 2. A new preview deployment every time you update your `develop` branch in GitHub
(for example, whenever you sync it with the latest `freesewing/freesewing` (for example, whenever you sync it with the latest `freesewing/freesewing`
updates) updates)