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

Missing documentation #68

Open
18 tasks
mikkel1156 opened this issue Jul 28, 2021 · 2 comments
Open
18 tasks

Missing documentation #68

mikkel1156 opened this issue Jul 28, 2021 · 2 comments
Labels
critical Critical features, improvements, or bug fixes documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@mikkel1156
Copy link

mikkel1156 commented Jul 28, 2021 •
edited by edufschmidt
Loading

This will serve as a list over the documentation that's missing, feel free to mention more and I'll add it to the list.

To help contribute to the docs, look at docs. This issue can also be used for coordination.

  • Installing Drago
    • Overview - Add go generate
    • Quickstart - Docker/makefile?
  • Configuration
    • Add new page for "top-level" configurations; data-dir, ports, name etc. (config)
    • ACL - Explain what the ACL system is for or link to HTTP API - Overview?
    • Client - Add missing options (config)
  • HTTP API
    • ACL Policies
    • ACL Tokens
    • Connections
    • Interfaces
    • Networks - Missing example
    • Nodes
    • Status
    • UI
  • Running Drago
    • Running in Docker

Comment any issues with the list.
@0x1a8510f2
Copy link

Docks for running in Docker should be improved because the current version is unable to interact with system WireGuard

For reference: https://github.com/gravitl/netmaker/blob/master/compose/docker-compose.reference.yml#L15

Previously #71

@0x1a8510f2 0x1a8510f2 mentioned this issue Aug 17, 2021
Closed
@edufschmidt
Copy link
Contributor

@0x1a8510f2 Already added this to the TODO list.

@edufschmidt edufschmidt added critical Critical features, improvements, or bug fixes documentation Improvements or additions to documentation help wanted Extra attention is needed labels Aug 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
critical Critical features, improvements, or bug fixes documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@edufschmidt @mikkel1156 @0x1a8510f2