-
Notifications
You must be signed in to change notification settings - Fork 33
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
Docs: recommend to install from packages #285
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me 👍
If you want to see it live in action, here's the rendered version: https://icinga.com/docs/icinga-web-graphite-integration/docs/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In addition to the requested changes please omit the the
in headings, e.g. Installing the ...
, Configuring the ...
. This is also the case in our other docs.
doc/02-Installation.md
Outdated
``` | ||
<!-- {% endif %} --> | ||
|
||
## Installing the Package |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Our other docs mention the product, please do so here as well, i.e. Installing Icinga Web Graphite Integration Package.
doc/02-Installation.md
Outdated
Please follow the steps listed for your target operating system, | ||
which guide you through setting up the repository and installation. | ||
|
||
<!-- {% else %} --> | ||
## Requirements |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would remove that completely, since it should be pretty obvious that you need Graphite to actually integrate it. 😆.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Graphite: yes. Graphite Web... ? I mean, I've grepped for Graphite Web and with a such change you'd have your Graphite doing... its Graphite things, you'll go through our install doc like oh, cool, I've installed everything and then in our config doc you'll be surprised with a Graphite Web URL being needed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[...] oh, cool, I've installed everything and then in our config doc you'll be surprised with a Graphite Web URL being needed.
You are absolutely right.
doc/06-Demonstration.md
Outdated
@@ -1,30 +1,31 @@ | |||
# <a id="Demonstration"></a>Demonstration |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#287 will remove the Dockerfile. Please revert the changes made here as this file is also subject to removal.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That issue shouldn’t take long to resolve. I'll rebase this one on top if necessary.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ready to rebase.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't quite like that the from source section is now buried in the sub directory. The ones reading this on Github are more likely to need that section in the main installation section.
There is a link pointing right to it in installation.md. |
I'll first have a look if you can convince Eric to do the same for Cube. |
Ah, didn't notice that! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I still find it wrong to read Configuring Icinga Web Graphite Integration
and not Configuring the Icinga Web Graphite Integration
. It's just better wording.
Blocked by