Skip to content

Commit

Permalink
website: update branding and things
Browse files Browse the repository at this point in the history
Signed-off-by: Joao Eduardo Luis <[email protected]>
  • Loading branch information
jecluis committed Mar 30, 2024
1 parent adf658e commit 6f1fa39
Show file tree
Hide file tree
Showing 88 changed files with 5,288 additions and 13,480 deletions.
9 changes: 9 additions & 0 deletions .vscode/settings.json
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"
}
639 changes: 438 additions & 201 deletions LICENSE

Large diffs are not rendered by default.

43 changes: 13 additions & 30 deletions README.md
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.
26 changes: 0 additions & 26 deletions blog/2022-07-22-sg3w-is-in-town.md

This file was deleted.

Loading

0 comments on commit 6f1fa39

Please sign in to comment.