From e3b6e374a526675e305c66e6e8fa9820ad46c1b7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Kr=C3=BCger=20Svensson?= Date: Wed, 1 Sep 2021 13:19:10 +0200 Subject: [PATCH] Docs for build and deployment of documentation --- docs/README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/README.md b/docs/README.md index a2a707f..83aa873 100644 --- a/docs/README.md +++ b/docs/README.md @@ -24,10 +24,15 @@ $ yarn build This command generates static content into the `build` directory and can be served using any static contents hosting service. -### Deployment +It's important that you build the documentation using `yarn build` **before pushing to `main`**. After building, +check that everything works, such as syntax highlighting etc. -``` -$ GIT_USER= USE_SSH=true yarn deploy -``` +If there are issues, please try +* to run `npm run clear` or `yarn clear` +* delete `package-lock.json` and re-.install packages + + +### Deployment -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. +GitHub actions takes care of deployment. Any changes to the `docs` folder on the `main` branch will trigger +the pipeline. You can see the documentation live at https://intility.github.io/fastapi-azure-auth/