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.

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

Create Readme Documentation for all services #5

Open
14 tasks
MoonTahoe opened this issue Jul 14, 2020 · 0 comments
Open
14 tasks

Create Readme Documentation for all services #5

MoonTahoe opened this issue Jul 14, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@MoonTahoe
Copy link
Member

MoonTahoe commented Jul 14, 2020 •
edited
Loading

Add content to the README.MD file for each service and gateway. Outline what that project does, show the schema, show users and students how to start and stop that services individually. If a database or environment variables are required to run the service, list those requirements.

Each Readme has:

  • Overview
  • Schema for service
  • How to install, start, and stop the service
  • Some sample and example queries

Each of these services has a readme
@MoonTahoe MoonTahoe added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jul 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@MoonTahoe