New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve readme file #257

Open

jesper-friis opened this issue Mar 29, 2023 · 1 comment

Labels

Contributor

jesper-friis commented Mar 29, 2023

Most users of oteapi-services would like to run it with Docker Compose in production mode. Place that section on top of the readme.

A more logical structure of the readme would be:

One-liner - "A RESTfull interface to OTEAPI" + illustrative figure
Table of content
About oteapi-services
Using oteapi
- Run oteapi-services
- OTEAPI Plugin Repositories
For developers
- Run oteapi-services as developer
- For plugin developers
Acknowledgements
License

jesper-friis added the documentation label

Contributor

CasperWA commented May 12, 2023

          Ok. Then the corresponding documentation for oteapi services should be updated.

Originally posted by @jesper-friis in SINTEF/entities-service#9 (comment)

CasperWA mentioned this issue

Enable custom port and user for mongodb + fixed typo in readme SINTEF/entities-service#9

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment