From 320ff95fe06513615b8bef1b5e1be4e9430f82a0 Mon Sep 17 00:00:00 2001 From: Irwan Fathurrahman Date: Fri, 23 Aug 2024 07:09:56 +0700 Subject: [PATCH 1/3] Fix workflow for mkdocs --- .github/workflows/mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml index c4e3dbf7..a74b0ae9 100644 --- a/.github/workflows/mkdocs.yml +++ b/.github/workflows/mkdocs.yml @@ -6,7 +6,7 @@ on: - docs # Paths can be used to only trigger actions when you have edited certain files, such as a file within the /docs directory paths: - - ".github/workflows/BuildMKDocsAndPublishToGithubPages.yml" + - ".github/workflows/mkdocs.yml" - "docs/**.md" - "docs/**.py" - "docs/assets/**" From f4dab8942b0a1becfff9bfc3d9790742b3a65693 Mon Sep 17 00:00:00 2001 From: ketan Date: Fri, 23 Aug 2024 11:30:45 +0530 Subject: [PATCH 2/3] Delete workfol --- .github/workflows/mkdocs.yml | 33 --------------------------------- 1 file changed, 33 deletions(-) delete mode 100644 .github/workflows/mkdocs.yml diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml deleted file mode 100644 index a74b0ae9..00000000 --- a/.github/workflows/mkdocs.yml +++ /dev/null @@ -1,33 +0,0 @@ -name: Publish docs via GitHub Pages -on: - push: - branches: - - main - - docs - # Paths can be used to only trigger actions when you have edited certain files, such as a file within the /docs directory - paths: - - ".github/workflows/mkdocs.yml" - - "docs/**.md" - - "docs/**.py" - - "docs/assets/**" - # Allow manually running in the actions tab - workflow_dispatch: - -jobs: - build: - name: Deploy docs - runs-on: ubuntu-latest - steps: - - name: Checkout main - uses: actions/checkout@v2 - - - name: Create Mkdocs Config 🚀 - working-directory: ./docs - run: ./create-mkdocs-html-config.sh - - - name: Deploy docs - uses: mhausenblas/mkdocs-deploy-gh-pages@master - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - CONFIG_FILE: /docs/mkdocs.yml - EXTRA_PACKAGES: build-base From 2d8f1f234bcad74b1ff5d7199b84c3f541290c3a Mon Sep 17 00:00:00 2001 From: ketan Date: Fri, 23 Aug 2024 12:43:23 +0530 Subject: [PATCH 3/3] Update index file --- docs/src/user/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/src/user/index.md b/docs/src/user/index.md index 9f6d81cd..d25d3633 100644 --- a/docs/src/user/index.md +++ b/docs/src/user/index.md @@ -18,5 +18,7 @@ This is the homepage for all user related documentation. The user content is divided into three sections: - The [quickstart tutorial](quickstart/index.md), which aims to get you familiar with the basics of platform in around 5 minutes. + - The [user guide](guide/index.md), which describes common workflows in a tutorial format. + - The [user manual](manual/index.md), which describes each page of the user interface and what the various options on that page do.