Skip to content
This repository has been archived by the owner on Jan 3, 2024. It is now read-only.

aquarist-labs/s3gw-website

Repository files navigation

s3gw 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.

The website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn 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

$ 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.