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

Document everything #5

Open
acieroid opened this issue Oct 15, 2014 · 2 comments
Open

Document everything #5

acieroid opened this issue Oct 15, 2014 · 2 comments
Milestone

Comments

@acieroid
Copy link
Owner

A lot of things need to be documented:

  1. The idea behind the project: why do we do that, how do we plan to do it, why it would be useful.
  2. The service files format should be described, with common patterns, example skeletons, how they will be called, what are the constraints
  3. The architecture of the service management should be described.
  4. Ideally we should have a brief description of every service we run and useful information about it.
@acieroid acieroid added this to the 0.1 milestone Oct 15, 2014
@mbivert
Copy link
Collaborator

mbivert commented Oct 18, 2014

abba8e2 should partially covers first point.

Suggesting diagrams for architecture description.

@acieroid
Copy link
Owner Author

From the README, what's left to do (I'm moving the TODO stuff from the README to here):

  • List of current convention
  • Software used
  • Per script description
  • Configuration files used and important options
  • How to create a new service? (user point of view)
  • How to deploy a new service? (admin perspective)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants