From d964236967b1cbced6a0cdc2a8a104eee6a4cb25 Mon Sep 17 00:00:00 2001 From: Michael Sprauer Date: Fri, 11 Sep 2020 18:05:34 +0200 Subject: [PATCH 1/2] mkdocs --- .github/workflows/doc.yaml | 18 +++++++++++ CONTRIBUTING.md | 16 +++++----- README.md | 6 ++-- ADDING_LICENSE.md => docs/ADDING_LICENSE.md | 0 DEMO_APP.md => docs/DEMO_APP.md | 0 .../DEVELOPMENT_ENVIRONMENT.md | 0 .../GUIDE_ADD_NEW_DISEASE.md | 0 .../GUIDE_ADD_NEW_FIELD.md | 0 .../GUIDE_SORMAS2SORMAS_CERTIFICATE.md | 0 I18N.md => docs/I18N.md | 0 I18nEditor.png => docs/I18nEditor.png | Bin I18nFiles.png => docs/I18nFiles.png | Bin LICENSE => docs/LICENSE | 0 LOAD_TESTING.md => docs/LOAD_TESTING.md | 0 RELEASE.md => docs/RELEASE.md | 0 .../SERVER_CUSTOMIZATION.md | 0 .../SERVER_DEV_SETUP.md | 0 SERVER_SETUP.md => docs/SERVER_SETUP.md | 0 SERVER_UPDATE.md => docs/SERVER_UPDATE.md | 0 SOP_DISEASES.md => docs/SOP_DISEASES.md | 0 docs/index.md | 17 ++++++++++ .../sormas_load_tests.zip | Bin mkdocs.yml | 29 ++++++++++++++++++ 23 files changed, 75 insertions(+), 11 deletions(-) create mode 100644 .github/workflows/doc.yaml rename ADDING_LICENSE.md => docs/ADDING_LICENSE.md (100%) rename DEMO_APP.md => docs/DEMO_APP.md (100%) rename DEVELOPMENT_ENVIRONMENT.md => docs/DEVELOPMENT_ENVIRONMENT.md (100%) rename GUIDE_ADD_NEW_DISEASE.md => docs/GUIDE_ADD_NEW_DISEASE.md (100%) rename GUIDE_ADD_NEW_FIELD.md => docs/GUIDE_ADD_NEW_FIELD.md (100%) rename GUIDE_SORMAS2SORMAS_CERTIFICATE.md => docs/GUIDE_SORMAS2SORMAS_CERTIFICATE.md (100%) rename I18N.md => docs/I18N.md (100%) rename I18nEditor.png => docs/I18nEditor.png (100%) rename I18nFiles.png => docs/I18nFiles.png (100%) rename LICENSE => docs/LICENSE (100%) rename LOAD_TESTING.md => docs/LOAD_TESTING.md (100%) rename RELEASE.md => docs/RELEASE.md (100%) rename SERVER_CUSTOMIZATION.md => docs/SERVER_CUSTOMIZATION.md (100%) rename SERVER_DEV_SETUP.md => docs/SERVER_DEV_SETUP.md (100%) rename SERVER_SETUP.md => docs/SERVER_SETUP.md (100%) rename SERVER_UPDATE.md => docs/SERVER_UPDATE.md (100%) rename SOP_DISEASES.md => docs/SOP_DISEASES.md (100%) create mode 100644 docs/index.md rename sormas_load_tests.zip => docs/sormas_load_tests.zip (100%) create mode 100644 mkdocs.yml diff --git a/.github/workflows/doc.yaml b/.github/workflows/doc.yaml new file mode 100644 index 00000000000..faa6d9c71a5 --- /dev/null +++ b/.github/workflows/doc.yaml @@ -0,0 +1,18 @@ +name: Publish docs via GitHub Pages +on: + push: + branches: + - master + +jobs: + build: + name: Deploy docs + runs-on: ubuntu-latest + steps: + - name: Checkout master + uses: actions/checkout@v1 + + - name: Deploy docs + uses: mhausenblas/mkdocs-deploy-gh-pages@master + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index da7e273ec6b..ea302baa1f7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,22 +50,22 @@ When submitting a change request or a feature request, describing the feature yo Even as a non-developer, there are a lot of things that you can help us with. If there is something you would like to do that you don't find instructions about here, make sure to contact us at sormas@helmholtz-hzi.de and let us know how we can assist you! -* [Translating SORMAS](I18N.md) -* [Defining new diseases](SOP_DISEASES.md) +* [Translating SORMAS](docs/I18N.md) +* [Defining new diseases](docs/SOP_DISEASES.md) ## Contributing to the Code If you're interested in participating in the development of SORMAS, you can use the following guides to get started. If you have problems setting up your development environment or don't know what you can work on, don't hesitate to contact us at sormas@helmholtz-hzi.de! -* [Setting up your local environment](DEVELOPMENT_ENVIRONMENT.md) -* [Performing load tests on a SORMAS server](LOAD_TESTING.md) -* [Adding license headers](ADDING_LICENSE.md) -* [How to add a new disease?](GUIDE_ADD_NEW_DISEASE.md) -* [How to add a new field?](GUIDE_ADD_NEW_FIELD.md) +* [Setting up your local environment](docs/DEVELOPMENT_ENVIRONMENT.md) +* [Performing load tests on a SORMAS server](docs/LOAD_TESTING.md) +* [Adding license headers](docs/ADDING_LICENSE.md) +* [How to add a new disease?](docs/GUIDE_ADD_NEW_DISEASE.md) +* [How to add a new field?](docs/GUIDE_ADD_NEW_FIELD.md) ### Development Contributing Guidelines -1. Use the eclipse code formatter (Ctrl+Shift+F) and the Android Studio code formatter for the **sormas-app** project. To not forget this, use save actions [for your IDE](DEVELOPMENT_ENVIRONMENT.md). +1. Use the eclipse code formatter (Ctrl+Shift+F) and the Android Studio code formatter for the **sormas-app** project. To not forget this, use save actions [for your IDE](docs/DEVELOPMENT_ENVIRONMENT.md). 2. Rules for blank lines (which cannot be enforced by automatic formatting): - Use one blank line after method definition (but usually not for one liners like getters/setters or delegation). - Use one blank line to separate statements within a code block from each other when you start a new logical block. diff --git a/README.md b/README.md index 9f426d41867..2384477309d 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,6 @@ The project consists of the following modules: ## Server Management -* [Installing a SORMAS server](SERVER_SETUP.md) -* [Updating a SORMAS server](SERVER_UPDATE.md) -* [Customizing a SORMAS server](SERVER_CUSTOMIZATION.md) +* [Installing a SORMAS server](docs/SERVER_SETUP.md) +* [Updating a SORMAS server](docs/SERVER_UPDATE.md) +* [Customizing a SORMAS server](docs/SERVER_CUSTOMIZATION.md) diff --git a/ADDING_LICENSE.md b/docs/ADDING_LICENSE.md similarity index 100% rename from ADDING_LICENSE.md rename to docs/ADDING_LICENSE.md diff --git a/DEMO_APP.md b/docs/DEMO_APP.md similarity index 100% rename from DEMO_APP.md rename to docs/DEMO_APP.md diff --git a/DEVELOPMENT_ENVIRONMENT.md b/docs/DEVELOPMENT_ENVIRONMENT.md similarity index 100% rename from DEVELOPMENT_ENVIRONMENT.md rename to docs/DEVELOPMENT_ENVIRONMENT.md diff --git a/GUIDE_ADD_NEW_DISEASE.md b/docs/GUIDE_ADD_NEW_DISEASE.md similarity index 100% rename from GUIDE_ADD_NEW_DISEASE.md rename to docs/GUIDE_ADD_NEW_DISEASE.md diff --git a/GUIDE_ADD_NEW_FIELD.md b/docs/GUIDE_ADD_NEW_FIELD.md similarity index 100% rename from GUIDE_ADD_NEW_FIELD.md rename to docs/GUIDE_ADD_NEW_FIELD.md diff --git a/GUIDE_SORMAS2SORMAS_CERTIFICATE.md b/docs/GUIDE_SORMAS2SORMAS_CERTIFICATE.md similarity index 100% rename from GUIDE_SORMAS2SORMAS_CERTIFICATE.md rename to docs/GUIDE_SORMAS2SORMAS_CERTIFICATE.md diff --git a/I18N.md b/docs/I18N.md similarity index 100% rename from I18N.md rename to docs/I18N.md diff --git a/I18nEditor.png b/docs/I18nEditor.png similarity index 100% rename from I18nEditor.png rename to docs/I18nEditor.png diff --git a/I18nFiles.png b/docs/I18nFiles.png similarity index 100% rename from I18nFiles.png rename to docs/I18nFiles.png diff --git a/LICENSE b/docs/LICENSE similarity index 100% rename from LICENSE rename to docs/LICENSE diff --git a/LOAD_TESTING.md b/docs/LOAD_TESTING.md similarity index 100% rename from LOAD_TESTING.md rename to docs/LOAD_TESTING.md diff --git a/RELEASE.md b/docs/RELEASE.md similarity index 100% rename from RELEASE.md rename to docs/RELEASE.md diff --git a/SERVER_CUSTOMIZATION.md b/docs/SERVER_CUSTOMIZATION.md similarity index 100% rename from SERVER_CUSTOMIZATION.md rename to docs/SERVER_CUSTOMIZATION.md diff --git a/SERVER_DEV_SETUP.md b/docs/SERVER_DEV_SETUP.md similarity index 100% rename from SERVER_DEV_SETUP.md rename to docs/SERVER_DEV_SETUP.md diff --git a/SERVER_SETUP.md b/docs/SERVER_SETUP.md similarity index 100% rename from SERVER_SETUP.md rename to docs/SERVER_SETUP.md diff --git a/SERVER_UPDATE.md b/docs/SERVER_UPDATE.md similarity index 100% rename from SERVER_UPDATE.md rename to docs/SERVER_UPDATE.md diff --git a/SOP_DISEASES.md b/docs/SOP_DISEASES.md similarity index 100% rename from SOP_DISEASES.md rename to docs/SOP_DISEASES.md diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000000..000ea3455fa --- /dev/null +++ b/docs/index.md @@ -0,0 +1,17 @@ +# Welcome to MkDocs + +For full documentation visit [mkdocs.org](https://www.mkdocs.org). + +## Commands + +* `mkdocs new [dir-name]` - Create a new project. +* `mkdocs serve` - Start the live-reloading docs server. +* `mkdocs build` - Build the documentation site. +* `mkdocs -h` - Print help message and exit. + +## Project layout + + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + ... # Other markdown pages, images and other files. diff --git a/sormas_load_tests.zip b/docs/sormas_load_tests.zip similarity index 100% rename from sormas_load_tests.zip rename to docs/sormas_load_tests.zip diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000000..9413980cd27 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,29 @@ +site_name: SORMAS +repo_name: 'hzi-braunschweig/SORMAS-Project' +repo_url: 'https://github.com/hzi-braunschweig/SORMAS-Project' + +theme: + name: material + features: + - tabs +extra: + version: 0.10 + palette: + primary: 'cyan' + social: + - icon: 'fontawesome/brands/github-alt' + link: 'https://github.com/hzi-braunschweig/SORMAS-Project' +plugins: +- search: + separator: '[\s]+' + +nav: +- For Developers: + - Automated Setup: 'DEVELOPMENT_ENVIRONMENT.md' + - Manual Setup: 'SERVER_SETUP.md' + - License: 'ADDING_LICENSE.md' +- For Admins: + - 'SERVER_CUSTOMIZATION.md' + - 'SERVER_UPDATE.md' + - 'SOP_DISEASES.md' +- Offical Website: "https://sormas.org" \ No newline at end of file From 0eace9f657a5bac58ebb41552867c716012fdbd7 Mon Sep 17 00:00:00 2001 From: Michael Sprauer Date: Fri, 11 Sep 2020 18:07:15 +0200 Subject: [PATCH 2/2] rename --- .github/workflows/doc.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/doc.yaml b/.github/workflows/doc.yaml index faa6d9c71a5..d94f20e5b80 100644 --- a/.github/workflows/doc.yaml +++ b/.github/workflows/doc.yaml @@ -2,7 +2,7 @@ name: Publish docs via GitHub Pages on: push: branches: - - master + - mkdocs jobs: build: