[dev.icinga.com #9379] Provide an about.md

[icinga-migration]

This issue has been migrated from Redmine: https://dev.icinga.com/issues/9379

Created by jmeyer on 2015-06-08 09:20:01 +00:00

Assignee: jmeyer
Status: Resolved (closed on 2015-06-10 10:05:04 +00:00)
Target Version: 2.0.0-rc1
Last Update: 2015-06-10 10:05:04 +00:00 (in Redmine)

---

Please provide a file called about.md for Icinga Web 2 (located at doc/) which contains a basic description what the framework has to offer:

• It's a framework and as such it is easily extensible with modules
  • Introduce the monitoring module to the user (especially the fact, that this is the module required to use Web 2 for monitoring purposes ;) )
• It provides powerful technologies to do everything with outstanding efficiency (Please do not put this exactly phrased this way into the file ;) )
  • Installation (Note that we've got packages and a http based wizard, Link to installation.md)
  • Configuration (Introduction, Link to configuration.md)
  • Authentication (Introduction, Link to authentication.md)
  • Authorization (Introduction, Link to security.md, see #9377)
  • User preferences (Introduction, Link to preferences.md)
  • Documentation (Short description (NO specifics, keep it short) of the documentation module)
  • Translation (Short description (NO specifics, keep it short) of the translation module and a list of currently provided languages: German, Italian, Portuguese)

These points are just representing the basic content, it's up to you how you'll phrase them. But make sure that it's designed for the end-user, not a developer.

Changesets

2015-06-08 15:43:12 +00:00 by aklimov d9f6857

Add doc/about.md

refs #9379

2015-06-09 12:19:48 +00:00 by aklimov 922bbad

doc/about.md: add introduction

refs #9379

2015-06-09 12:23:43 +00:00 by aklimov 5412c6d

doc/about.md: add section `The monitoring module'

refs #9379

2015-06-09 12:54:50 +00:00 by aklimov 260a33c

Add introduction to section `Configuration'

refs #9379

2015-06-09 13:14:27 +00:00 by aklimov ee7c912

Add introduction to section `Authentication'

refs #9379

2015-06-09 13:39:19 +00:00 by aklimov 5cea5d1

Add introduction to section `User preferences'

refs #9379

2015-06-09 13:52:44 +00:00 by aklimov b8debcd

Add introduction to section `User preferences'

refs #9379

2015-06-09 14:49:44 +00:00 by aklimov 85b3eaa

Add introduction to section `Authorization'

refs #9379

2015-06-09 15:04:02 +00:00 by aklimov 7cf0b82

doc/about.md: typos and grammar

refs #9379

2015-06-09 15:12:25 +00:00 by aklimov f02b899

Improve section `Configuration'

refs #9379

2015-06-10 10:00:24 +00:00 by aklimov ca08deb

Merge branch 'feature/Provide-an-about-md-9379'

resolves #9379

[icinga-migration]

Updated by jmeyer on 2015-06-09 14:28:58 +00:00

Looks mostly good, except the following things:

• "for more information about the installation." or "for more information about how to install Icinga Web 2."
• "via the user interface and the .ini files " (You can't be sure that it's this path, yet the fact that it's configurable should also not be noted in such a generic overview.)
• "for more information about the configuration." or "for more information about how to configure Icinga Web 2."
• "authentication methods can be easily configured. ("
• "for more information about the different authentication methods available."
• "Besides the global configuration " (what is data/authentication? I do also think that's unnecessary information..)
• "for more information about a user's preferences and how to configure their storage type.
• "choise" => "choice"

[icinga-migration]

Updated by aklimov on 2015-06-09 15:17:35 +00:00

• Status changed from Assigned to Feedback
• Assigned to changed from aklimov to jmeyer

[icinga-migration]

Updated by aklimov on 2015-06-10 10:05:04 +00:00

• Status changed from Feedback to Resolved
• Done % changed from 0 to 100

Applied in changeset ca08deb.