beenull/ente
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
ente/docs
History
Manav Rathi 26b162c8dc
[web] Allow running the build outside of a git repository 
This was found useful by @Bramas when building a Dockerfile of the web app
itself. See https://github.com/ente-io/ente/pull/1065.

Now, the GIT_SHA environment variable can just be undefined if we're not in a
git repository, and the code using it deals with that case explicitly.

**Tested by**

Temporarily inverted the isDevBuild flag, tehn

1. Ran the build normally and verified that the SHA continued to appear in the logs.

2. Ran the build after copying to a standalone folder without an associated git
   repository and verified that the SHA was skipped without causing the build to
   fail.
2024-03-13 11:15:12 +05:30
..
docs [web] Allow running the build outside of a git repository 2024-03-13 11:15:12 +05:30
.gitignore Move into docs/ 2024-03-01 12:43:55 +05:30
.prettierrc.json Move into docs/ 2024-03-01 12:43:55 +05:30
package.json Update to latest vitepress 2024-03-07 13:28:36 +05:30
README.md yarn pretty 2024-03-11 10:31:07 +05:30
yarn.lock Update to latest vitepress 2024-03-07 13:28:36 +05:30

README.md

Docs

Help and documentation for Ente's products.

You can find the live version of these at help.ente.io.

Quick edits

You can edit these files directly on GitHub and open a pull request. help.ente.io will automatically get updated with your changes in a few minutes after your pull request is merged.

Running locally

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 things locally.

Clone this repository

git clone https://github.com/ente-io/ente

Change to this directory

cd ente/docs

Install dependencies

yarn install

Then start a local server

yarn dev

For an editor, VSCode is a good choice. Also install the Prettier extension for VSCode, and set VSCode to format on save. This way the editor will automatically format and wrap the text using the project's standard, so you can just focus on the content.

Have fun!

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!