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

New documentation structure #4321

Closed
cakrit opened this issue Sep 29, 2018 · 1 comment · Fixed by #4713
Closed

New documentation structure #4321

cakrit opened this issue Sep 29, 2018 · 1 comment · Fixed by #4713
Assignees
Labels
area/docs priority/high Super important issue
Milestone

Comments

@cakrit
Copy link
Contributor

cakrit commented Sep 29, 2018

Restructure tree as follows:

Guides

  • Welcome Guide
  • Installation Guide
  • Configuration Guide
  • Tuning Guide
  • Systems Monitoring Reference
  • Applications Monitoring Reference (could be a automatically generated, interactive)
  • APM (statsd)
  • Metrics Streaming & Replication
  • Metrics Archiving (backends)
  • Health Monitoring & Notifications
  • Alarms Reference (could be automatically generated, interactive)
  • Netdata Registry
  • APIs Reference (data collection, web API, etc)
  • Custom Dashboards & Badges (including reference for each chart library we use)
  • Development Guide (write plugins, protocols used, APIs, etc)

How To:

  • Monitoring web servers
  • Netdata with Prometheus
  • Monitoring Ephemeral Nodes
  • Monitoring Kubernetes
  • Monitoring Containers and Virtual Machines
  • Monitoring an IoT cloud
  • Monitoring the process tree with netdata
  • Visual Anomaly Detection with netdata
@cakrit cakrit self-assigned this Sep 29, 2018
@cakrit
Copy link
Contributor Author

cakrit commented Nov 4, 2018

I structured the content differently, trying to follow the way atom does it. The current draft can be seen at https://netdata.netlify.com
We definitely need:

  • Better separation of user and developer documentation
  • Get impressions/suggestions

This was referenced Nov 11, 2018
@cakrit cakrit modified the milestones: v1.12, v1.12-rc0 Nov 18, 2018
@cakrit cakrit added the priority/high Super important issue label Nov 19, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs priority/high Super important issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant