Skip to content
This repository has been archived by the owner on May 5, 2021. It is now read-only.

Mkdocs #20

Draft
wants to merge 2 commits into
base: development
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/doc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Publish docs via GitHub Pages
on:
push:
branches:
- mkdocs

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 }}
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
17 changes: 17 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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.
File renamed without changes.
29 changes: 29 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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"