1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
unleash.unleash/website
Fredrik Strand Oseberg 50fb671b66
Docs/dev docs (#2134)
* docs: add ADRs

* docs/adrs

* fix: update developer guide

* fix: add space

* Update website/docs/contributing/backend/overview.md

Co-authored-by: Ivar Conradi Østhus <ivar@getunleash.ai>

* docs: remove auto-generated sidebar

This should've been in .gitignore, but has only been ignored to the
ignore file for the website subdirectory. (This has been fixed on main.)

* docs: delete empty file

* Revert "docs: delete empty file"

This reverts commit 2435f173ff.

* docs: add frontmatter to new dev docs

* Docs(fix): add quotes around page titles

In yaml, the colon is a special character, so we need to use quotes.

* docs: fix remaining titles

* Update website/docs/contributing/backend/overview.md

Co-authored-by: Ivar Conradi Østhus <ivar@getunleash.ai>

* fix: update empty ADR

* fix: update text to reflect postgres 12

* fix: update backend overview

* fix: remove link

* fix: add form ADR

Co-authored-by: Ivar Conradi Østhus <ivar@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-10-19 14:32:37 +02:00
..
.storybook docs(docs): document the use of AliasPlugin for theme resolution 2022-04-02 16:47:38 +02:00
docs Docs/dev docs (#2134) 2022-10-19 14:32:37 +02:00
src docs: add "The Anatomy of Unleash" (#2138) 2022-10-19 13:14:49 +02:00
static docs: add "The Anatomy of Unleash" (#2138) 2022-10-19 13:14:49 +02:00
.gitignore Docs/public signup (#2070) 2022-10-10 16:12:11 +03:00
babel.config.js
clean-generated-docs.js Fix(#1391): fix edge case URLs in code samples (#2078) 2022-09-21 11:24:25 +02:00
docusaurus.config.js docs: Remove/update references to Heroku (#2099) 2022-10-19 12:02:00 +00:00
package.json chore(deps): update dependency @babel/core to v7.19.3 (#2160) 2022-10-10 08:13:08 +00:00
README.md
sidebars.js docs: add "The Anatomy of Unleash" (#2138) 2022-10-19 13:14:49 +02:00
tsconfig.json chore: convert feedback component to typescript 2022-03-02 10:50:46 +01:00
yarn.lock chore(deps): update dependency @babel/core to v7.19.3 (#2160) 2022-10-10 08:13:08 +00:00

Website

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

Installation

yarn install

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.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

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.