diff --git a/.github/workflows/docker-compose-tests.yml b/.github/workflows/docker-compose-tests.yml index 4b3e32b4b..8dd1e6c79 100644 --- a/.github/workflows/docker-compose-tests.yml +++ b/.github/workflows/docker-compose-tests.yml @@ -22,7 +22,7 @@ jobs: uses: actions/checkout@v3 - name: Run tests against database container - run: docker-compose -f docker-compose.yml -f tests/docker-compose-test.yml up --build --exit-code-from backend + run: docker compose -f docker-compose.yml -f tests/docker-compose-test.yml up --build --exit-code-from backend - name: Setup upterm session uses: lhotari/action-upterm@v1 diff --git a/.github/workflows/publish_and_trivyscan.yml b/.github/workflows/publish_and_trivyscan.yml index f39ab382e..7bd44a6c8 100644 --- a/.github/workflows/publish_and_trivyscan.yml +++ b/.github/workflows/publish_and_trivyscan.yml @@ -24,12 +24,13 @@ on: types: [published] jobs: build_tech_overview: - name: Build Technical Overview + name: Build technical overview runs-on: ubuntu-latest steps: - name: Check out the repo uses: actions/checkout@v4 - - uses: docker://pandoc/latex:3.2 + - name: Build tech overview PDF + uses: docker://pandoc/latex:3.2 with: entrypoint: /bin/sh args: >- @@ -39,14 +40,39 @@ jobs: updmap-sys && pandoc --output=dds_web/static/dds-technical-overview.pdf - doc/technical-overview.md" - - name: Upload PDF artifact + doc/technical-overview.md + " + - name: Upload technical overview PDF uses: actions/upload-artifact@v4 with: - name: tech-overview-pdf + name: technical-overview-pdf path: dds_web/static/dds-technical-overview.pdf + build_troubleshooting: + name: Build troubleshooting guide + runs-on: ubuntu-latest + steps: + - name: Check out the repo + uses: actions/checkout@v4 + - name: Build troubleshooting guide + uses: docker://pandoc/latex:3.2 + with: + entrypoint: /bin/sh + args: >- + -c " + tlmgr update --self && + tlmgr install cm-super fontaxes lato xkeyval && + updmap-sys && + pandoc + --output=dds_web/static/dds-troubleshooting.pdf + doc/troubleshooting.md + " + - name: Upload troubleshooting PDF + uses: actions/upload-artifact@v4 + with: + name: troubleshooting-pdf + path: dds_web/static/dds-troubleshooting.pdf push_to_registry: - needs: build_tech_overview + needs: [build_tech_overview, build_troubleshooting] if: github.repository == 'ScilifelabDataCentre/dds_web' name: Push image runs-on: ubuntu-latest @@ -66,11 +92,16 @@ jobs: registry: ghcr.io username: ${{ github.actor }} password: ${{ secrets.GITHUB_TOKEN }} - - name: Download Tech Overview artifact + - name: Download technical overview PDF + uses: actions/download-artifact@v4 + with: + name: technical-overview-pdf + path: dds_web/static/dds-technical-overview.pdf + - name: Download troubleshooting PDF uses: actions/download-artifact@v4 with: - name: tech-overview-pdf - path: dds_web/static + name: troubleshooting-pdf + path: dds_web/static/dds-troubleshooting.pdf - name: Docker metadata id: meta uses: docker/metadata-action@v5 diff --git a/Makefile b/Makefile index 036e73448..f75e6ba30 100644 --- a/Makefile +++ b/Makefile @@ -1,15 +1,22 @@ # For Linux and MacOS users only and assumes brew is already installed TECH_MARKDOWN_FILE := doc/technical-overview.md -PDF_OUTFILE := dds_web/static/dds-technical-overview.pdf +TECH_OVERVIEW_PDF := dds_web/static/dds-technical-overview.pdf +TROUBLE_MARKDOWN_FILE := doc/troubleshooting.md +TROUBLE_PDF := dds_web/static/dds-troubleshooting.pdf install_pandoc: - brew install pandoc + brew install pandoc basictex librsvg update_tlmgr: tlmgr update --self tlmgr install cm-super fontaxes lato pdflscape xkeyval build_tech_overview_pdf: update_tlmgr $(TECH_MARKDOWN_FILE) - pandoc $(TECH_MARKDOWN_FILE) -o $(PDF_OUTFILE) + pandoc $(TECH_MARKDOWN_FILE) -o $(TECH_OVERVIEW_PDF) -.PHONY: update_tlmgr build_tech_overview_pdf all +build_troubleshooting_pdf: update_tlmgr $(TROUBLE_MARKDOWN_FILE) + pandoc $(TROUBLE_MARKDOWN_FILE) -o $(TROUBLE_PDF) + +build_docs: build_tech_overview_pdf build_troubleshooting_pdf + +.PHONY: update_tlmgr build_tech_overview_pdf build_troubleshooting_pdf build_docs all diff --git a/README.md b/README.md index 6ea2af20d..0bb2111a0 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ Architecture Decision Record - + Troubleshooting diff --git a/SPRINTLOG.md b/SPRINTLOG.md index a89fde3a2..7fbfc2b1d 100644 --- a/SPRINTLOG.md +++ b/SPRINTLOG.md @@ -412,3 +412,7 @@ _Nothing merged in CLI during this sprint_ - Build Technical Overview PDF in GitHub Actions, rename to include DDS and remove option to view on GitHub ([#1541](https://github.com/ScilifelabDataCentre/dds_web/pull/1541/)) - Fixed index out of range when listing files from root ([#1543](https://github.com/ScilifelabDataCentre/dds_web/pull/1543/)) - Update Trivy GitHub Actions ([#1545](https://github.com/ScilifelabDataCentre/dds_web/pull/1545)) + +# 2024-07-29 - 2024-08-09 + +- Move raw troubleshooting doc to repo and make small updates ([#1546](https://github.com/ScilifelabDataCentre/dds_web/pull/1546)) diff --git a/dds_web/templates/troubleshooting.html b/dds_web/templates/troubleshooting.html index 9f8d60351..248b0b8ff 100644 --- a/dds_web/templates/troubleshooting.html +++ b/dds_web/templates/troubleshooting.html @@ -5,8 +5,7 @@

Troubleshooting the DDS


Experiencing issues with the DDS?

Please read the troubleshooting document which provides answers to previously asked questions and possible solutions to issues that have been reported.

-

The document can be found on GitHub or downloaded as a PDF.

-

Read on GitHub Download the PDF 

+

Download the PDF 


Did the troubleshooting document not help?

Please go through the following steps:

@@ -16,8 +15,8 @@

Did the troubleshooting document not help?

  • Read through the sections in the technical overview relevant to your issue and check the topics below for possible solutions.

  • -

    Does the issue persist and / or the provided information not help?

    -

    If you're a data producer , using the DDS for data deliveries to your users: contact the +

    Does the issue persist and/or the provided information not help?

    +

    If you're a data producer, using the DDS for data deliveries to your users: contact the

    -

    If you're a data recipient , using the DDS to download your data from a data producing SciLifeLab unit: contact the SciLifeLab unit responsible for delivering the data to you.

    +

    If you're a data recipient, using the DDS to download your data from a data producing SciLifeLab unit: contact the SciLifeLab unit responsible for delivering the data to you.

    Please provide the following information: