Skip to content

Commit 59864cf

Browse files
authored
chore: Remove yarn from documentation (#1065)
# Description Removing mention of Yarn from building docs, since npm is used instead. ## Related Issue #988 ## Checklist - [x] I have read the [contributing documentation](https://retina.sh/docs/contributing). - [x] I signed and signed-off the commits (`git commit -S -s ...`). See [this documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) on signing commits. - [x] I have correctly attributed the author(s) of the code. - [x] I have tested the changes locally. - [x] I have followed the project's style guidelines. - [x] I have updated the documentation, if necessary. - [ ] I have added tests, if applicable. --- Please refer to the [CONTRIBUTING.md](../CONTRIBUTING.md) file for more information on how to contribute to this project. --------- Signed-off-by: Kamil <[email protected]>
1 parent 5ff1567 commit 59864cf

File tree

2 files changed

+4
-46
lines changed

2 files changed

+4
-46
lines changed

docs/07-Contributing/developing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The easiest way to set up your Development Environment is to use the provided Gi
99
## Environment Config
1010

1111
- [Go](https://go.dev/doc/install)
12-
- Docker
12+
- [Docker](https://docs.docker.com/engine/install/)
1313
- [Helm](https://helm.sh/docs/intro/install)
1414
- jq: `sudo apt install jq`
1515
- Fork the repository

site/README.md

+3-45
Original file line numberDiff line numberDiff line change
@@ -4,50 +4,8 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta
44

55
## Development
66

7-
When adding a new doc, make sure to add it to /site/sidebars.js
7+
When adding a new doc, make sure to add it to `/site/sidebars.js` to display it in the sidebar.
88

9-
To test, run `make docs` to spin up local webserver and view changes with hot reload
9+
> Prerequisite: [Docker](https://docs.docker.com/engine/install/)
1010
11-
## Using Yarn
12-
13-
### Installation
14-
15-
Install `yarn` (e.g. for Ubuntu, try [this guide](https://www.linuxcapable.com/how-to-install-yarn-on-ubuntu-linux/#install-yarn-on-ubuntu-2204-or-2004-via-nodesource)).
16-
17-
In this directory (*retina/site/*), run:
18-
19-
```bash
20-
yarn
21-
```
22-
23-
### Local Development
24-
25-
```bash
26-
yarn start
27-
```
28-
29-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
30-
31-
### Build
32-
33-
```bash
34-
yarn build
35-
```
36-
37-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
38-
39-
## Deployment
40-
41-
Using SSH:
42-
43-
```bash
44-
USE_SSH=true yarn deploy
45-
```
46-
47-
Not using SSH:
48-
49-
```bash
50-
GIT_USER=<Your GitHub username> yarn deploy
51-
```
52-
53-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
11+
To test your changes, run `make docs` from the root directory to spin up local webserver and view changes with hot reload.

0 commit comments

Comments
 (0)