Skip to content
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.

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

Provide detailed documentation #62

Open
uniqueg opened this issue Oct 9, 2018 · 1 comment
Open

Provide detailed documentation #62

uniqueg opened this issue Oct 9, 2018 · 1 comment
Assignees
Labels
priority: medium Medium priority type: docs Improvements or additions to documentation workload: days Likely takes days to resolve

Comments

@uniqueg
Copy link
Member

uniqueg commented Oct 9, 2018

Is your feature request related to a problem? Please describe.
Detailed documentation on how to use the service are missing.

Describe the solution you'd like
Write an in-depth documentation on Read the Docs. The documentation should be directed at:

  • Users who want to use test the service ("demo server")
  • Users who want to deploy the service (installation & configuration)
  • Users who want to use our/any WES client to access the service (clarification of docs in the specs & any implementation-specific solutions)
  • Developers who want to contribute to further building the service ("API" section)

Describe alternatives you've considered
N/A

Additional context
N/A

@uniqueg uniqueg added this to the Release candidate v1.0.0-rc milestone Oct 9, 2018
@fgypas
Copy link
Contributor

fgypas commented Nov 7, 2018

Check also #76

@uniqueg uniqueg self-assigned this Nov 11, 2018
@uniqueg uniqueg removed this from the Release candidate v1.0.0-rc milestone Sep 1, 2019
@uniqueg uniqueg added priority: medium Medium priority type: docs Improvements or additions to documentation workload: days Likely takes days to resolve labels Apr 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: medium Medium priority type: docs Improvements or additions to documentation workload: days Likely takes days to resolve
Projects
None yet
Development

No branches or pull requests

2 participants