Conversation
With the docker compose setup, we have a version of the server software that serves minio_url, so we can include it in our comparison
The documentation also says to specify an index using a "!!" syntax but this seems to be unsafe yaml, which does not get past the validator. So for now I will leave it out - emojis seem to render just fine, if not a bit flat.
|
Hi @Taniya-Das, could you have a look at the new documentation and identify if there are still any issues with it?
You should be able to make changes to either of them and see the servers reflect the changes (e.g., modify a REST API endpoint or change documentation). You should be able to run all unit tests (from a docker container, at least). I realize that instructions on how to actually contribute by means of adding a new endpoint is underdocumented, but at this point I figured it's better to merge partial progress now as it already is a big chunk of automation and documentation. |
Since we now have an easily reproducible and identical test database behind the PHP API, we can be more strict about ensuring there are no differences in the data. Only changed interfaces are now accounted for in the unit tests.
|
Merging this but still really interested in the feedback and I will process that in separate PRs. |
|
Hi! I have verified the documentation and I could
The documentation is clear and easy to follow. |
This PR adds documentation pages for the project, with instructions on installing and developing this project.
It also adds a number of files to create and spin up docker images, to ease the setup of a development environment.
Sorry for including both in the same PR.
Work in progress, to add:
Postponed for a separate PR:
Closes #7 #70 #76