diff options
| -rw-r--r-- | HACKING | 24 | ||||
| -rw-r--r-- | README.md | 17 |
2 files changed, 37 insertions, 4 deletions
@@ -1,3 +1,27 @@ +# Parabolaweb HACKING + +Things you should know: + +1. You don't need to mess with the fixtures every time you want to add + something. It's OK to just add it through the web-based admin + interface. The fixtures are for setting up the inital data that + things might not work without. + +2. Please don't add new pages to the `legacy_urls` list in `urls.py`. + It's for old, compatibility URLs. But once it's added there, it's + there forever, don't remove it. + +Which branch you should use: + + - If it's a Parabola-specific change, put it on `master`. + - If it's not Parabola-specific, put it on `archweb-generic`, then + merge it into `master`. + +Following is Archweb's version of the HACKING file; you should follow +it too. + +# Archweb HACKING + Contributing ====================== @@ -1,10 +1,19 @@ # Parabolaweb README -It is recommended that you just install the (parabola) package + +It is recommended that you just install the (Parabola) package `parabolaweb-utils`, it - - depends on the dependencies of parabolaweb - - offers initscripts and systemd service files for parabolaweb - - has a `parabolaweb-update` script that does most of the things here. + - depends on the dependencies of parabolaweb (that is, don't use + virtualenv) + - has a `parabolaweb-update` program that does most of the things here + - has a `parabolaweb-changepassword` program that allows system users + to change their parabolaweb password + - has `/etc/uwsgi/parabolaweb.ini.example` + +To run parabolaweb, you can use `./manage testserver` to run a small +HTTP server, or run `systemctl enable --now uwsgi@parabolaweb.socket`, +and stick that behind a proper web server that speaks WSGI (such as +Nginx). Following is Archweb's readme, as I figure it might be useful for some people, but I have given up on maintaining it for parabolaweb. |