diff --git a/.github/workflows/writerside.yml b/.github/workflows/writerside.yml new file mode 100644 index 00000000..8f409d78 --- /dev/null +++ b/.github/workflows/writerside.yml @@ -0,0 +1,103 @@ +name: Build documentation + +on: + # If specified, the workflow will be triggered automatically once you push to the `main` branch. + # Replace `main` with your branch’s name + push: + branches: ["feature/docs"] + # Specify to run a workflow manually from the Actions tab on GitHub + workflow_dispatch: + +# Gives the workflow permissions to clone the repo and create a page deployment +permissions: + id-token: write + pages: write + +env: + # Name of module and id separated by a slash + INSTANCE: Writerside/docs + # Replace HI with the ID of the instance in capital letters + ARTIFACT: webHelpDOCS2-all.zip + # Writerside docker image version + DOCKER_VERSION: 232.10275 + # Add the variable below to upload Algolia indexes + # Replace HI with the ID of the instance in capital letters + ALGOLIA_ARTIFACT: algolia-indexes-DOCS.zip + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Build Writerside docs using Docker + uses: JetBrains/writerside-github-action@v4 + with: + instance: ${{ env.INSTANCE }} + artifact: ${{ env.ARTIFACT }} + docker-version: ${{ env.DOCKER_VERSION }} + + - name: Upload documentation + uses: actions/upload-artifact@v3 + with: + name: docs + path: | + artifacts/${{ env.ARTIFACT }} + artifacts/report.json + retention-days: 7 + + # Add the step below to upload Algolia indexes + - name: Upload algolia-indexes + uses: actions/upload-artifact@v3 + with: + name: algolia-indexes + path: artifacts/${{ env.ALGOLIA_ARTIFACT }} + retention-days: 7 + + # Add the job below and artifacts/report.json on Upload documentation step above if you want to fail the build when documentation contains errors + test: + # Requires build job results + needs: build + runs-on: ubuntu-latest + + steps: + - name: Download artifacts + uses: actions/download-artifact@v1 + with: + name: docs + path: artifacts + + - name: Test documentation + uses: JetBrains/writerside-checker-action@v1 + with: + instance: ${{ env.INSTANCE }} + + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + # Requires the build job results + needs: test + runs-on: ubuntu-latest + steps: + - name: Download artifact + uses: actions/download-artifact@v4 + with: + name: docs + + - name: Unzip artifact + run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir + + - name: Setup Pages + uses: actions/configure-pages@v2 + + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + with: + path: dir + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v1 \ No newline at end of file diff --git a/docs/c.list b/Writerside/c.list similarity index 100% rename from docs/c.list rename to Writerside/c.list diff --git a/docs/redirection-rules.xml b/Writerside/redirection-rules.xml similarity index 100% rename from docs/redirection-rules.xml rename to Writerside/redirection-rules.xml diff --git a/docs/topics/Functions.md b/Writerside/topics/Functions.md similarity index 100% rename from docs/topics/Functions.md rename to Writerside/topics/Functions.md diff --git a/docs/topics/class.md b/Writerside/topics/class.md similarity index 100% rename from docs/topics/class.md rename to Writerside/topics/class.md diff --git a/docs/topics/classes/classes.md b/Writerside/topics/classes/classes.md similarity index 100% rename from docs/topics/classes/classes.md rename to Writerside/topics/classes/classes.md diff --git a/docs/topics/classes/enum.md b/Writerside/topics/classes/enum.md similarity index 100% rename from docs/topics/classes/enum.md rename to Writerside/topics/classes/enum.md diff --git a/docs/topics/contributing.md b/Writerside/topics/contributing.md similarity index 100% rename from docs/topics/contributing.md rename to Writerside/topics/contributing.md diff --git a/docs/topics/overview.md b/Writerside/topics/overview.md similarity index 100% rename from docs/topics/overview.md rename to Writerside/topics/overview.md diff --git a/docs/topics/placeholders.md b/Writerside/topics/placeholders.md similarity index 100% rename from docs/topics/placeholders.md rename to Writerside/topics/placeholders.md diff --git a/docs/topics/starter-topic.md b/Writerside/topics/starter-topic.md similarity index 94% rename from docs/topics/starter-topic.md rename to Writerside/topics/starter-topic.md index 03052b6b..df62eaf2 100644 --- a/docs/topics/starter-topic.md +++ b/Writerside/topics/starter-topic.md @@ -1,7 +1,7 @@ # About Wiki - + ## Add new topics You can create empty topics, or choose a template for different types of content that contains some boilerplate structure to help you get started: diff --git a/docs/topics/variables.md b/Writerside/topics/variables.md similarity index 100% rename from docs/topics/variables.md rename to Writerside/topics/variables.md diff --git a/docs/v.list b/Writerside/v.list similarity index 100% rename from docs/v.list rename to Writerside/v.list diff --git a/docs/w.tree b/Writerside/w.tree similarity index 100% rename from docs/w.tree rename to Writerside/w.tree diff --git a/docs/writerside.cfg b/Writerside/writerside.cfg similarity index 78% rename from docs/writerside.cfg rename to Writerside/writerside.cfg index d9a1be18..fb41ccdc 100644 --- a/docs/writerside.cfg +++ b/Writerside/writerside.cfg @@ -4,6 +4,6 @@ - + \ No newline at end of file diff --git a/docs/images/completion_procedure.png b/docs/images/completion_procedure.png deleted file mode 100644 index 3535a3f3..00000000 Binary files a/docs/images/completion_procedure.png and /dev/null differ diff --git a/docs/images/completion_procedure_dark.png b/docs/images/completion_procedure_dark.png deleted file mode 100644 index a65beb0e..00000000 Binary files a/docs/images/completion_procedure_dark.png and /dev/null differ diff --git a/docs/images/convert_table_to_xml.png b/docs/images/convert_table_to_xml.png deleted file mode 100644 index 2518a64c..00000000 Binary files a/docs/images/convert_table_to_xml.png and /dev/null differ diff --git a/docs/images/convert_table_to_xml_dark.png b/docs/images/convert_table_to_xml_dark.png deleted file mode 100644 index 47161226..00000000 Binary files a/docs/images/convert_table_to_xml_dark.png and /dev/null differ diff --git a/docs/images/new_topic_options.png b/docs/images/new_topic_options.png deleted file mode 100644 index bc6abb62..00000000 Binary files a/docs/images/new_topic_options.png and /dev/null differ diff --git a/docs/images/new_topic_options_dark.png b/docs/images/new_topic_options_dark.png deleted file mode 100644 index bf3e48d1..00000000 Binary files a/docs/images/new_topic_options_dark.png and /dev/null differ