kompetenzinventar
/
ki-doku
6
1
Fork 1
Code Issues 31 Pull Requests Projects Releases 2 Wiki Activity
Dokumentation und issues für das Projekt Kompetenzinventar
22 Commits 1 Branch 2 Tags 114 KiB
Dockerfile 67.8%
Makefile 32.2%
Go to file
jaschop 4a3065dc3c Merge pull request 'Added Dockerfile & docker build instructions' (#54) from dockerize into master 
Reviewed-on: #54
 		2023-09-28 18:08:39 +02:00
.gitea/issue_template tweak issue templates 2022-01-14 16:06:21 +01:00
doc profile_visible -> visible 2021-07-01 09:16:14 +02:00
.gitignore initial README and docs taken over and adapted from membersteward-repo 2021-05-28 22:20:20 +02:00
Dockerfile added Dockerfile & docker build instructions in README 2023-09-28 17:59:12 +02:00
Makefile make builds now singlehtml and pdf version of document 2021-05-31 21:18:27 +02:00
README.md added docker image size warning 2023-09-28 18:05:28 +02:00

README.md

Kompetenzinventar

Dieses Repo enthält die Dokumentation des Projekts Kompentenzinventar - einer Webapplkation zur Erfassung von Userprofilen für die WTF eG.

In diesem Repo werden ausserdem die Issues des gesamten Kompentenzinventar-Projektes gesammelt.

Es existiert jweils ein Repo für den Frontend- und den Backend-Code:

Building

Building the ki-doku depends on the following Python packages:

  • sphinx
  • sphinxcontrib-plantuml

as well as the system dependency plantuml, which you can get e.g. with apt install plantuml

Building with Docker

You can also build the docs using docker:

docker build -t ki-doku-builder .
docker run -v $(pwd)/doc:/doc ki-doku-builder

# results:
#   ./doc/build/latex/kompetenzinventar.pdf
#   ./doc/build/singlehtml/

Warning: the builder uses the sphinx-latexpdf base image, which contains an entire texlive environment, making it very large (~2.9G).

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(Pull requests currently require an account on our private gitea, but we faithfully await deliverance from our federated lord and saviour.)

License

Distributed under the ??? License. See LICENSE for more information.

Contact

Project Link: https://git.wtf-eg.de/kompetenzinventar