Add basic documentation

This MR adds a configuration and source content for documentation for the server, to be rendered using gitlab pages.

This closes #8 (closed) via the inclusion of a complete API v1 specification.

requested review from @duncan.meacher

assigned to @duncan.meacher

changed milestone to %GWDataFind Server 1.1.0

Example docs can be viewed here: https://duncanmmacleod.docs.ligo.org/-/gwdatafind-server/-/jobs/1846411/artifacts/site/index.html

This should be "Start the Apache httpd server and gunicorn service" as gunicorn is what starts the gwdatafind server. I suspect that apache will need to be started before gunicorn.

if you start apache and browse before gunicorn is started you'll get an http 500 error. if you start gunicorn and try to browse before apache starts you'll get a timeout error.

One optimization you can do is to setup a system socket that will (re) start gunicorn when a connection is attempted on its port. that would give a reasonably high confidence that gunicorn is started when it is needed.

https://www.freedesktop.org/software/systemd/man/systemd.socket.html

@duncan.meacher, this is deliberately called the 'gwdatafind-server' service because the gunicorn configuration is specific to gwdatafind - the fact that it is gunicorn underneath is effectively irrelevant to the (average) administrator.

@philippe.grassia, could you propose a systemd socket file for this?

added 2 commits

• ca7eb08c - spec: install systemd files with RPM
• b46b41e6 - spec: set Prefix for RPMs

Compare with previous version

added 2 commits

• 4178f45c - spec: install systemd files with RPM
• be461d79 - spec: set Prefix for RPMs

Compare with previous version

added 2 commits

• c15354e6 - spec: install systemd files with RPM
• f276349a - spec: set Prefix for RPMs

Compare with previous version

approved this merge request

merged

mentioned in commit 04ca34e0