Skip to content
This repository has been archived by the owner on Apr 22, 2020. It is now read-only.

Several issue worth checking in documentation #74

Open
elgris opened this issue Jun 27, 2017 · 0 comments
Open

Several issue worth checking in documentation #74

elgris opened this issue Jun 27, 2017 · 0 comments
Labels
chore technical debts, operational excellence, compliance and minor security topics, re-factoring needs revisit relevant issue. Needs to be tackled as part of current stabilising work

Comments

@elgris
Copy link
Contributor

elgris commented Jun 27, 2017

  1. https://docs.zmon.io/en/latest/intro.html:
  • no zmon-eventlog-service on the diagram. However, it is listed in "minimum ZMON setup requirements"
  • sentence "ZMON provides many custom wrappers that bind to the selected entity". There should be a link to list of wrappers. If there is no documentation about wrappers - it should be created.
  • sentence "ZMON provides many custom wrappers that bind to the selected entity". Better add a screenshot illustrating the sentence.
  • sentence "REST API and CLI". Missing link to REST API and CLI documentation
  1. https://docs.zmon.io/en/latest/getting-started.html:
  • Vagrant is deprecated, better provide a description of setting up with docker compose
  • Screenshots illustrating the actions (Create a new Check, Create an Alert, etc) could be useful
  1. https://docs.zmon.io/en/latest/user/entities.html
  • What is entity "type" and what is it used for?
  1. https://docs.zmon.io/en/latest/user/check-definitions.html
  • "Using trial run" section lacks description or link to description
  1. https://docs.zmon.io/en/latest/user/alert-definitions.html
  1. https://docs.zmon.io/en/latest/user/dashboards.html
  • Need to specify somewhere at the beginning that Flot charts is used for widgets
  1. https://docs.zmon.io/en/latest/user/check-commands.html
  • Examples are missing for: metric_data, query_logs, count_logs, methods of history
  • No information about how to configure access to AWS Cloudwatch
  • It's unclear how Counter works until you read that section to the end. Better to put an explanation first. It should explain what counter is, how it's stored, how it's accessed from the checks.
  • Elasticsearch. How does that piece authenticate with Elasticsearch if oauth2 parameter is false?
  • "If url is None, then the plugin will use the default Elasticsearch cluster set in worker configuration.": worker configuration should be a link pointing to worker documentation
  • Better to explain how oauth2_token_name (check HTTP section) works
  1. https://docs.zmon.io/en/latest/installation/requirements.html
  • Worth adding links to Redis, PostgreSQL and Cassandra projects
vetinari pushed a commit that referenced this issue Jan 22, 2018
which were mentioned in #74
john-coleman added a commit to john-coleman/zmon-docs that referenced this issue Jun 27, 2018
* Statistic is returned in dict, not Metric
* Add some more examples for percentile extended statistics
@rajatparida86 rajatparida86 added the revisit relevant issue. Needs to be tackled as part of current stabilising work label Aug 2, 2018
mohabusama pushed a commit that referenced this issue Dec 6, 2018
* Statistic is returned in dict, not Metric
* Add some more examples for percentile extended statistics
@pitr pitr added the chore technical debts, operational excellence, compliance and minor security topics, re-factoring needs label May 16, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
chore technical debts, operational excellence, compliance and minor security topics, re-factoring needs revisit relevant issue. Needs to be tackled as part of current stabilising work
Projects
None yet
Development

No branches or pull requests

3 participants