forked from aquarist-labs/s3gw-website
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Joao Eduardo Luis <[email protected]>
- Loading branch information
Showing
102 changed files
with
5,813 additions
and
13,480 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
{ | ||
"[typescriptreact]": { | ||
"editor.tabSize": 2, | ||
"editor.defaultFormatter": "esbenp.prettier-vscode" | ||
}, | ||
"editor.formatOnPaste": true, | ||
"prettier.tabWidth": 2, | ||
"editor.defaultFormatter": "esbenp.prettier-vscode" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,43 +1,26 @@ | ||
# s3gw Website | ||
# Website | ||
|
||
This repo contains the content of the s3gw landing page. Please open an issue if you have suggestions for new content or edits. We also gladly accept community PRs. | ||
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. | ||
|
||
The website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. | ||
## Installation | ||
|
||
### Installation | ||
|
||
``` | ||
$ yarn | ||
```shell | ||
# npm ci | ||
``` | ||
|
||
### Local Development | ||
## Local Development | ||
|
||
``` | ||
$ yarn start | ||
```shell | ||
# npm start | ||
``` | ||
|
||
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. | ||
|
||
You can also use Docker to launch the website without needing to install and configure yarn: | ||
``` | ||
docker run --rm -it -v $PWD:$PWD -w $PWD -p 3000:3000 node yarn start -h 0.0.0.0 | ||
``` | ||
|
||
### Build | ||
## Build | ||
|
||
```shell | ||
# npm run build | ||
``` | ||
$ yarn build | ||
``` | ||
|
||
This command generates static content into the `build` directory and can be served using any static contents hosting service. | ||
|
||
### Deployment | ||
|
||
An automated GH action will deploy the website to GitHub Pages once a PR has been merged to `main`. | ||
|
||
### Static Files | ||
|
||
The `static` subdirectory contains static files both for this website as well as | ||
other parts of the project. In particular, image files containing the logo are | ||
hosted there, which are used in other parts of the project as well, e.g. the | ||
helm chart. Take extra care when moving or modifying the static content. | ||
This command generates static content into the `build` directory and can be | ||
served using any static contents hosting service. |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.