mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-22 19:07:54 +01:00
d23266decb
This PR updates the docs to clarify that we don't support multi-host strings in the databaseUrl configuration variable. The docs used to just mention that we accept libpq strings, but as reported in #3221, we **don't** support multi-host strings. I did some digging and found that this is because [node-postgres -- the library we use to connect to postgres -- itself does not support multi-host strings](https://github.com/brianc/node-postgres/issues/2308). To fix this, we would need to replace the library we use or otherwise wrap it. While this would be a better long-term solution, we don't have the capacity to it right now. But we can update the docs to better reflect reality. |
||
|---|---|---|
| .. | ||
| .storybook | ||
| docs | ||
| remote-content | ||
| src | ||
| static | ||
| .gitignore | ||
| babel.config.js | ||
| clean-generated-docs.js | ||
| docusaurus.config.js | ||
| package.json | ||
| README.md | ||
| sidebars.js | ||
| tsconfig.json | ||
| yarn.lock | ||
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.