This repository has been archived on 2024-04-08. You can view files and clone it, but cannot push or open issues or pull requests.
dagger/website
Gerhard Lazu 5de4a7e75b
Always build the docs website
If we trigger a deploy, then we want the deploy to actually run.

I am assuming that this was in place when there was a single GitHub
Actions workflow that would trigger this all the time, even when nothing
changed in `docs/**`. Since https://github.com/dagger/dagger/pull/1498,
we no longer have this problem.

After merging https://github.com/dagger/dagger/pull/1591, I was caught
by this behaviour which to me seemed surprising. This change should make
docs deploy via Netlify behave in a more predictable way.

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-02-10 11:07:46 +00:00
..
cypress docs: 🐛 increate cypress get timeout to avoid github action errors 2022-01-19 10:42:12 +01:00
plugins/docusaurus-plugin-hotjar docs: collect feedback form 2021-08-06 15:29:23 +02:00
src Bump up docusaurus theme + downgrade mdx-js/react causing issue with docusaurus config 2022-02-07 11:47:35 +01:00
static Improve doc's main image loading time 2022-01-12 01:01:51 +01:00
.gitignore docs: remove .env 2021-06-14 14:15:12 +02:00
.prettierrc docs: 🐛 fix css for mobile devices 2021-08-25 09:38:34 +02:00
babel.config.js docs: rename tools/daggosaurus to website 2021-06-04 13:49:20 -07:00
cypress.json docs: init cypress test e2e 2021-08-10 15:39:13 +02:00
docsearch.config.json update docusaurus to v2.0.0-beta.5 2021-09-07 14:39:57 +02:00
docusaurus.config.js docs: 🐛 fix editurl path 2022-01-13 16:00:35 +01:00
netlify.toml Always build the docs website 2022-02-10 11:07:46 +00:00
package.json Bump up docusaurus theme + downgrade mdx-js/react causing issue with docusaurus config 2022-02-07 11:47:35 +01:00
README.md docs: rename tools/daggosaurus to website 2021-06-04 13:49:20 -07:00
sidebars.js Add the must-have pages for the Europa release 2022-02-10 09:47:07 +00:00
yarn.lock Bump up docusaurus theme + downgrade mdx-js/react causing issue with docusaurus config 2022-02-07 11:47:35 +01: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.