[web] Finalize deployment process (#755)
These changes were all made in previous PRs, this PR just ties up the loose ends and updates the documentation etc.
This commit is contained in:
commit
353eb67cab
|
@ -50,13 +50,13 @@ Thank you for your support.
|
|||
|
||||
## Document
|
||||
|
||||
_Coming soon!_
|
||||
|
||||
The help guides and FAQs for users of Ente products are also open source, and
|
||||
can be edited in a wiki-esque manner by our community members. More than the
|
||||
quantity, we feel this helps improve the quality and approachability of the
|
||||
documentation by bringing in more diverse viewpoints and familiarity levels.
|
||||
|
||||
See [docs/](docs/README.md) for how to edit these documents.
|
||||
|
||||
## Code contributions
|
||||
|
||||
If you'd like to contribute code, it is best to start small.
|
||||
|
|
|
@ -7,7 +7,7 @@ details as possible about whatever it is that you need help with, and we will
|
|||
get back to you as soon as possible.
|
||||
|
||||
In some cases, your query might already have been answered in our help
|
||||
documentation (_Coming soon!_).
|
||||
documentation at [help.ente.io](https://help.ente.io).
|
||||
|
||||
Other ways to get in touch are:
|
||||
|
||||
|
|
|
@ -1,12 +1,9 @@
|
|||
# Docs
|
||||
|
||||
Help and documentation for Ente's products
|
||||
Help and documentation for Ente's products.
|
||||
|
||||
> [!CAUTION]
|
||||
>
|
||||
> **Currently not published**. There are bits we need to clean up before
|
||||
> publishing these docs. They'll likely be available at help.ente.io once we
|
||||
> wrap those loose ends up.
|
||||
You can find the live version of these at
|
||||
**[help.ente.io](https://help.ente.io)**.
|
||||
|
||||
## Quick edits
|
||||
|
||||
|
@ -19,7 +16,7 @@ changes in a few minutes after your pull request is merged.
|
|||
|
||||
The above workflow is great since it doesn't require you to setup anything on
|
||||
your local machine. But if you plan on contributing frequently, you might find
|
||||
it easier to run everything locally.
|
||||
it easier to run things locally.
|
||||
|
||||
Clone this repository
|
||||
|
||||
|
@ -52,17 +49,6 @@ the content.
|
|||
|
||||
## Have fun!
|
||||
|
||||
Note that we currently don't enforce these formatting standards to make it easy
|
||||
for people unfamiliar with programming to also be able to make edits from GitHub
|
||||
directly.
|
||||
|
||||
This is a common theme - unlike the rest of the codebase where we expect some
|
||||
baseline understanding of the tools involved, the docs are meant to be a place
|
||||
for non-technical people to also provide their input. The reason for this is not
|
||||
to increase the number of docs, but to bring more diversity to them. Such
|
||||
diversity of viewpoints is essential for evolving documents that can be of help
|
||||
to people of varying level of familiarity with tech.
|
||||
|
||||
If you're unsure about how to do something, just look around in the other files
|
||||
and copy paste whatever seems to match the look of what you're trying to do. And
|
||||
remember, writing docs should not be a chore, have fun!
|
||||
|
|
|
@ -3,23 +3,26 @@
|
|||
The various web apps and static sites in this repository are deployed on
|
||||
Cloudflare Pages.
|
||||
|
||||
The summary of what happens is:
|
||||
|
||||
* Production deployments are triggered by pushing to the `deploy/*` branches.
|
||||
Use the various `yarn deploy:*` commands to help with this. For example, `yarn
|
||||
deploy:photos` will open a PR to merge the current `main` onto
|
||||
`deploy/photos`, which'll trigger a deployment and deploy the code to
|
||||
[web.ente.io](https://web.ente.io).
|
||||
|
||||
* [help.ente.io](https://help.ente.io) gets deployed whenever a PR that changes
|
||||
anything inside `docs/` gets merged to `main`.
|
||||
|
||||
* Every night, all the web apps get automatically deployed to a nightly preview
|
||||
URLs using the current code in main. This workflow can also be triggered
|
||||
manually.
|
||||
URLs using the current code in main.
|
||||
|
||||
Use the various `yarn deploy:*` commands to help with production deployments.
|
||||
For example, `yarn deploy:photos` will open a PR to merge the current `main`
|
||||
onto `deploy/photos`, which'll trigger the deployment workflow, which'll build
|
||||
and publish to [web.ente.io](https://web.ente.io).
|
||||
|
||||
> When merging these deployment PRs, remember to use rebase and merge so that
|
||||
> their HEAD is a fast forward of `main` instead of diverging from it because of
|
||||
> the merge commit.
|
||||
|
||||
## Deployments
|
||||
Here is a list of all the deployments, whether or not they are production
|
||||
deployments, and the action that triggers them.
|
||||
deployments, and the action that triggers them:
|
||||
|
||||
| URL | Type |Deployment action |
|
||||
|-----|------|------------------|
|
||||
|
@ -29,10 +32,10 @@ deployments, and the action that triggers them.
|
|||
| [accounts.ente.io](https://accounts.ente.io) | Production | Push to `deploy/accounts` |
|
||||
| [cast.ente.io](https://cast.ente.io) | Production | Push to `deploy/cast` |
|
||||
| [help.ente.io](https://help.ente.io) | Production | Push to `main` + changes in `docs/` |
|
||||
| [TBD-photos.ente.io](https://photos.ente.sh) | Preview | Nightly deploy of `main` |
|
||||
| [TBD-auth.ente.io](https://auth.ente.sh) | Preview | Nightly deploy of `main` |
|
||||
| [TBD-accounts.ente.io](https://accounts.ente.sh) | Preview | Nightly deploy of `main` |
|
||||
| [TBD-cast.ente.io](https://cast.ente.sh) | Preview | Nightly deploy of `main` |
|
||||
| [accounts.ente.sh](https://accounts.ente.sh) | Preview | Nightly deploy of `main` |
|
||||
| [auth.ente.sh](https://auth.ente.sh) | Preview | Nightly deploy of `main` |
|
||||
| [cast.ente.sh](https://cast.ente.sh) | Preview | Nightly deploy of `main` |
|
||||
| [photos.ente.sh](https://photos.ente.sh) | Preview | Nightly deploy of `main` |
|
||||
|
||||
### Other subdomains
|
||||
|
||||
|
@ -47,7 +50,8 @@ Apart from this, there are also some other deployments:
|
|||
repositories (Enhancement: bring them in here).
|
||||
|
||||
---
|
||||
---
|
||||
|
||||
## Details
|
||||
|
||||
The rest of the document describes details about how things were setup. You
|
||||
likely don't need to know them to be able to deploy.
|
||||
|
|
Loading…
Reference in a new issue