Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • Teckids/schul-frei/schul-frei.dev
  • benni/schul-frei.org
  • philh/schul-frei.org
  • jonah09/schul-frei.org
  • hansegucker/schul-frei.org
  • schubisu/schul-frei.org
6 results
Show changes
Commits on Source (423)
Showing
with 141 additions and 6 deletions
...@@ -27,7 +27,6 @@ pip-delete-this-directory.txt ...@@ -27,7 +27,6 @@ pip-delete-this-directory.txt
# Translations # Translations
*.mo *.mo
*.pot
# Django stuff: # Django stuff:
*.log *.log
......
image: python:3.8-buster image: python:3.9-bullseye
variables: variables:
GIT_SUBMODULE_STRATEGY: recursive GIT_SUBMODULE_STRATEGY: recursive
PIP_EXTRA_INDEX_URL: https://edugit.org/api/v4/projects/257/packages/pypi/simple
pages: pages:
stage: deploy stage: deploy
before_script: before_script:
- pip install Markdown gitpython pelican py_w3c - apt-get -y update && apt-get -y install po4a
- pip install -r requirements.txt
script: script:
- make publish - make publish
environment:
production
artifacts: artifacts:
paths: paths:
- public/ - public/
only: only:
- master - master
pages_staging:
stage: test
before_script:
- apt-get -y update && apt-get -y install po4a
- pip install -r requirements.txt
script:
- make publish
environment:
staging
artifacts:
paths:
- public/
only:
- merge_requests
[submodule "plugins"] [submodule "plugins"]
path = plugins path = plugins
url = https://github.com/getpelican/pelican-plugins url = https://github.com/getpelican/pelican-plugins
[submodule "themes/teckids"]
path = themes/teckids
url = https://edugit.org/Teckids/team-sysadmin/teckids-pelican
Contribution guidelines
=======================
To keep a consistent and clean code and development environment, we follow some conventions.
This document uses great parts of `Contribution Guidelines of AlekSIS`_.
Working with the Git repository
-------------------------------
The Git repository shall be used as a historic documentation of development
and as change management. It is important that the Git commit history
describes what was changed, by whom and why.
Help and information on Git for beginners are available in the `Git guide`_
Feature and issue branches
~~~~~~~~~~~~~~~~~~~~~~~~~~
All greater changes should be developed in their own branch and later
merged into the master branch as a whole. Of course, sometimes, it is
sensible to not do that, e.g. for fixing mere typos and the like.
Within the branch, every logical step should be commited separately.
It is neither required nor desired to do micro-commits about every
development step. The commit history should describe the trains of thought
the design and implementation is based on.
If you work on multiple issues at the same time, you have to change between
branches. Never work on unrelated issues in the same branch.
Branches should either contain the number and title of the related issue (as
generated by GitLab), or use a very short description as its name.
All changes on the code should be commited and pushed before stopping work on
in order to prevent data loss. If a logical step is continued later, you
should amend and force-push the commit.
Issue branches should be rebased onto the current master regularly to avoid
merge conflicts.
Commit messages
~~~~~~~~~~~~~~~
Commit messages should be written as described in `How to Write a Git Commit
Message`_.
Commit messages should mention or even close any related issues. For merely
mentioning progress on an issue, use the keyword `advances`; for closing an
issue, use `closes`; for referring to a related issue for informational
purposes, use `cf.`. This should be done in the body of the commit message.
The subject of a commit message can (and should) be prepended with a tag in
square brackets if it relates to a certain part of the repository, e.g. [CI]
when changing CI/CD configuration or support code, [Dev] when changing
something in the development utilities, etc.
Example::
Solve LDAP connection problems
- Add the ldap-with-unicorn-dust dependency
- Configure settings.py to accept the correct groups from LDAP
Closes #10.
Merge Requests
~~~~~~~~~~~~~~
If you think that the work on your feature branch is finished, you have to
create a merge request on EduGit in order to let other developers and the
maintainers take a look at it.
See below on how to submit patches if you cannot use the development
platform.
Merge Requests must only be merged by maintainers and must fulfill all of
the following preconditions before merging:
- All discussions must be resolved
- The most recent pipeline must have succeeded (including all related pipelines)
- If the merge request changes the frontend, it must include screenshots
- If the merge request fixes a bug, it must reference and close an issue with an
appropriate issue description
Accessibility
~~~~~~~~~~~~~
To make our website accessible for everyone, it's important to follow markup, naming and other conventions,
that e.g. screen readers need to provide a good user experience.
More information can be found in the `WCAG Quick Reference`_
.. _Contribution Guidelines of AlekSIS: https://edugit.org/AlekSIS/official/AlekSIS/-/blob/master/CONTRIBUTING.rst
.. _Git guide: https://rogerdudler.github.io/git-guide/
.. _How to Write a Git Commit Message: https://chris.beams.io/posts/git-commit/
.. _WCAG Quick Reference`: https://www.w3.org/WAI/WCAG21/quickref/
# Repository der schul-frei.org-Website
## Einrichten der Entwicklungsumgebung
### Unter UNIX-like Systemen (GNU/Linux-Distributionen, BSDs, MacOS)
0. Dieses Repository mit Submodules klonen. `git clone --recurse-submodules https://edugit.org/Teckids/schul-frei/schul-frei.dev`
Falls das Repository schon ohne Submodules geklont wurde, kann man diese mit `git submodule update --init` initalisieren.
1. Python3.x, pip und po4a installieren. Dies sollte aus den Paketquellen des Betriebssystems geschehen.
Unter Debian mit dem Befehl `sudo apt install python3 python3-pip po4a`
2. Python-Bibliotheken installieren. Diese werden nun mit pip3 installiert, der Vorgang ist auf allen Systemen gleich.
`pip3 install -r requirements.txt`
3. Den Entwicklungsserver starten. `make devserver` Die Website ist nun lokal unter 127.0.0.1:8000 erreichbar. Diesen Prozess am besten in einem seperaten Terminalfenster starten, dann können Änderungen gemacht werden, ohne den Server stoppen und starten zu müssen.
### Unter Windows 10
1. Die neueste Python-Version von [hier](https://www.python.org/downloads/) herunterladen
2. In Git Bash folgenden Befehl ausführen: `pip3 install Markdown gitpython pelican py_w3c beautifulsoup4`
3. Im Wurzelverzeichnis des Projektes `pelican content -o content/public -s pelicanconf.py` und `pelican -l content -o content/public -s pelicanconf.py -p 8000` ausführen. Die Website ist nun lokal unter 127.0.0.1:8000 erreichbar.
content/images/aleksis/aleksis01.jpg

66.7 KiB

content/images/aleksis/aleksis02.jpg

92.4 KiB

content/images/bbb/bbb00.jpg

154 KiB

content/images/bbb/bbb01.jpg

36.7 KiB

content/images/bbb/bbb02.jpg

19 KiB

content/images/bbb/bbb03.jpg

96 KiB

content/images/bbb/bbb04.jpg

135 KiB

content/images/favicon.png

17 KiB

content/images/hackathon/hackathon01.jpg

70.7 KiB

content/images/hackathon/hackathon02.jpg

62.9 KiB

content/images/hackathon/hackathon03.jpg

47 KiB

content/images/index/001.jpg

122 KiB

content/images/index/002.jpg

298 KiB

content/images/index/003.jpg

270 KiB

content/images/index/004.jpg

416 KiB