Skip to content

[documentation] write docs #11

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

Open
mgrzybek opened this issue Jan 15, 2020 · 2 comments
Open

[documentation] write docs #11

mgrzybek opened this issue Jan 15, 2020 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@mgrzybek
Copy link
Collaborator

We should find:

  • internals and technical architecture ;
  • how to install the appliances into an existing project ;
  • how to send data èto the tools ;
  • how to use the tools.
@mgrzybek mgrzybek added the documentation Improvements or additions to documentation label Jan 15, 2020
@fredmj
Copy link
Contributor

fredmj commented Mar 31, 2020

Maybe also a plan for the doc. A plan splitted into chapters and with an order of reading :
The main entry point of the doc could be the Readme.md. With a link to description.md and so on ...

  1. Index
  2. Chapter 1
  3. Chapter 2
    2-a. parahraph a
    ... etc

@mgrzybek
Copy link
Collaborator Author

mgrzybek commented Apr 2, 2020

I've just added a file : https://github.com/139bercy/cloud-appliance-observability/blob/master/docs/README.md

Pandoc can create a table of content but it's quite difficult to deal with splitted markdown files.

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

No branches or pull requests

3 participants