From 4ad7388bc6b2474374e7a959bc7bf77d23e29908 Mon Sep 17 00:00:00 2001 From: Eric Schrock Date: Mon, 30 Sep 2019 17:02:43 -0400 Subject: [PATCH] check docs on pull request --- .github/workflows/pull-request.yml | 11 +++++++++++ docs/src/lifecycle/diagnosis.rst | 4 ++-- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml index 9c5fd8ea..d23cfd7f 100644 --- a/.github/workflows/pull-request.yml +++ b/.github/workflows/pull-request.yml @@ -18,3 +18,14 @@ jobs: java-version: '8.0.212' - name: Run Maven Tests run: ./mvnw clean verify + docs: + name: Build Documentation + runs-on: ubuntu-18.04 + steps: + - uses: actions/checkout@v1 + - name: Install virtualenv + run: sudo pip3 install virtualenv + - name: Build documentation + run: | + export PATH=/usr/local/bin:$PATH + ./docs/build.sh -r development -v development diff --git a/docs/src/lifecycle/diagnosis.rst b/docs/src/lifecycle/diagnosis.rst index 3f52f4e1..75f385c4 100644 --- a/docs/src/lifecycle/diagnosis.rst +++ b/docs/src/lifecycle/diagnosis.rst @@ -44,9 +44,9 @@ to see if you can get it to work. Installation Issues ------------------- -When you're running ``titan install``, the server container may or may not +When you're running :ref:`cli_cmd_install`, the server container may or may not be running successfully. In these cases, you can use ``docker logs titan-launch`` -to see what may be going on within the process. The lines denoted ``TITAN` are +to see what may be going on within the process. The lines denoted ``TITAN`` are designed to be more user-readable, while the other error messages may be internal.