[dev.icinga.com #7153] End user documentation

[icinga-migration]

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

Created by tgelf on 2014-09-09 11:19:23 +00:00

Assignee: (none)
Status: New
Target Version: Backlog
Last Update: 2016-10-21 12:57:58 +00:00 (in Redmine)

---

Our documentation is currently an unsorted amount of partially outdated developer guidelines. Documentation should first of all help Icinga users to get their daily work done. Only AFTER that we want to see guidelines for module developers and the very LAST entries should target Icinga Web developers contributing to the framework itself.

Best,
Thomas

Changesets

2015-06-01 17:16:35 +00:00 by (unknown) cf95994

Documentation: Add config overview as first draft

refs #7153

2015-09-27 15:12:24 +00:00 by mfriedrich 9a06afb

Doc: Restart the webserver after changing group membership

refs #7153
fixes #9484

2015-09-27 15:32:24 +00:00 by mfriedrich e0e7fe2

Move upgrading to a dedicated section and add a link

refs #7153

2015-09-29 17:50:08 +00:00 by mfriedrich 7c28a20

Document example commands for installing from source

That also adds all the details we use for automated deployments
and manual installations (e.g. mysql db setup, user creation, manual
config files).

Maybe this could be split into installation-from-source.md
somewhere in the future, but for now it should help anyone
out there to deploy Icinga Web 2 w/o running the setup wizard
in automated environments.

fixes #8407
refs #9595
refs #7153

2015-09-29 17:57:44 +00:00 by mfriedrich 0c50c84

Document example commands for installing from source

That also adds all the details we use for automated deployments
and manual installations (e.g. mysql db setup, user creation, manual
config files).

Maybe this could be split into installation-from-source.md
somewhere in the future, but for now it should help anyone
out there to deploy Icinga Web 2 w/o running the setup wizard
in automated environments.

fixes #8407
refs #9595
refs #7153

2015-10-02 07:50:51 +00:00 by mfriedrich 48bee8d

Doc: Restart the webserver after changing group membership

refs #7153
fixes #9484

2015-10-02 07:50:52 +00:00 by mfriedrich 73dfb28

Move upgrading to a dedicated section and add a link

refs #7153

2015-10-02 07:50:52 +00:00 by mfriedrich ded631b

Document example commands for installing from source

That also adds all the details we use for automated deployments
and manual installations (e.g. mysql db setup, user creation, manual
config files).

Maybe this could be split into installation-from-source.md
somewhere in the future, but for now it should help anyone
out there to deploy Icinga Web 2 w/o running the setup wizard
in automated environments.

fixes #8407
refs #9595
refs #7153

2015-10-02 07:51:15 +00:00 by mfriedrich 5a14a3c

Merge branch 'feature/doc-7153'

refs #7153

2015-10-02 08:36:39 +00:00 by mfriedrich c3b5d8a

Doc: Fix typo

refs #7153

2015-10-02 08:44:33 +00:00 by mfriedrich 9a28855

Merge branch 'feature/doc-7153'

refs #7153

---

Subtasks:

• Feature 9512 - Add documentation for creating users through the UI
• Feature 5519 - Make CLI documentation available to the docs module
• Bug 8471 - Document how to define a custom configuration directory
• Feature 8539 - Document Gravatar integration for the contact views
• Feature 8789 - Document how to add custom documentation directories
• Feature 8431 - Doc module should respect README.md if available
• Feature 9595 - Add documentation for setup (wizard and manual)
• Feature 9612 - Document LDAP filter setting in authentication.md
• Bug 9227 - Missing documentation on configuring LDAP to AD backends
• Feature 9648 - Document how to integrate Web 2 into NagVis
• Feature 9988 - Document option to disable stack traces
• Feature 10001 - Allow to link foreign documentation from modules and the framework
• Feature 10810 - Document how to hide menu and header

Relations:

• relates #7153

[icinga-migration]

Updated by elippmann on 2014-10-28 10:36:59 +00:00

• Category set to Documentation
• Target Version set to 2.0-16

[icinga-migration]

Updated by mfriedrich on 2014-11-13 22:54:49 +00:00

doc/authentication.md contains wrong information about the sql backend. there is no 'password' or 'salt' column anymore.

[icinga-migration]

Updated by elippmann on 2014-11-21 15:39:14 +00:00

• Target Version changed from 2.0-16 to Backlog

[icinga-migration]

Updated by elippmann on 2015-03-31 08:08:13 +00:00

• Relates set to 6497

[icinga-migration]

Updated by icinga-kanban on 2015-06-01 17:18:55 +00:00

Build !#791 triggered by commit cf95994 passed successfully.

Branch: origin/master
Author: Michael Friedrich

[icinga-migration]

Updated by elippmann on 2015-06-29 14:30:30 +00:00

• Subject changed from Provide an end user documentation to End user documentation
• Target Version changed from Backlog to 2.0.0

[icinga-migration]

Updated by icinga-kanban on 2015-09-27 15:34:59 +00:00

Build !#1035 triggered by commit e0e7fe2 passed successfully.

Branch: origin/feature/doc-7153
Author: Michael Friedrich

[icinga-migration]

Updated by icinga-kanban on 2015-09-27 15:40:49 +00:00

Build !#1036 triggered by commit fddab71 passed successfully.

Branch: origin/feature/doc-7153
Author: Michael Friedrich

[icinga-migration]

Updated by icinga-kanban on 2015-09-29 17:55:13 +00:00

Build !#1075 triggered by commit 7c28a20 passed successfully.

Branch: origin/feature/doc-7153
Author: Michael Friedrich

[icinga-migration]

Updated by icinga-kanban on 2015-09-29 17:59:53 +00:00

Build !#1076 triggered by commit 0c50c84 passed successfully.

Branch: origin/feature/doc-7153
Author: Michael Friedrich

[icinga-migration]

Updated by icinga-kanban on 2015-10-02 07:59:26 +00:00

Build !#1078 triggered by the commits 5a14a3c, ded631b, f077f45, 73dfb28, 48bee8d passed successfully.

Branch: origin/master
Author: Michael Friedrich

[icinga-migration]

Updated by mfriedrich on 2015-10-02 08:02:29 +00:00

I'd suggest moving this issue to 2.1.0 and leave it with high priority. We may come up with all the required details and screenshots once the new layout is ready for screenshots and all changes are applied and won't affect the user documentation structure.

[icinga-migration]

Updated by icinga-kanban on 2015-10-02 08:41:56 +00:00

Build !#1162 triggered by the commits c3b5d8a, ded631b, f077f45, 73dfb28, 48bee8d, 359dde7, 1b91eff, bb386ac, e4a42c5, f8ac2c8, fde7525, 61357da, e788682, 14ae04b, 8c8af9c, b63a956, 0cc06d6, d54e5f6, 57f30b1, 50e6681, c7d5e14, b80cfe7, aa3bff5, 6affad6, 92b0bfa, 85e7e79, 5f7f0a9, 5b71d0b, 27524fe, 4b06d47, 3cd3a78, cdc534f, 7cbafe7, 2ca161c, a2474ad, c2ac841, 142851e, bd206e3, 16cdd76, eef4322, 4156901, 722152a, 62d96a1, 13575eb, 1c7b398, ff25c24, 8b0c820, 915b559, ddeed57, 6b31898, 6a61d4a, a2827e0, bbd6845, 633dca6, 037fee2, befbc6c, 95d1ce3, 7db05fa, 527b146, bcbe764, 0f622fe, c4ac3cb, aa76925, bd42169, f4e4dbe, 690fc89, e96d0c2, bbd59d4, 178ebd2, 2f79c2f, 58c630b, 185c0b4, 956c86d, df69755, e22dd1d, d18d606, 944129d, 73152e9, 6519b25, 844f80d, 6307af9, d0f11e1, 02eee7a, 7071716, d2d960d, 92778ec, 0896589, e4e0ad7, 041c72b, 1f040df, e8ce410, a3b74fe, 3623cf5, cd52189, b5561a8, 2ce63ad, c597a67, a9588c9, 0221559, e110649, 1de527c, 0a8369e, 64783fd, e416a44, 64ba37a, 7901601, d2d6815, dcb4f7f, 1c44a33, 4b76115, eb970b1, 8d0e57c, b4bcfa4, 4921b1a, 5657041, 5d4f7cf, 6fdfef4, f60a8ef, 2be8835, 0d0480a, f6e6767, 35e62ae, e5f035c, d720180, b055920, 624f505, 5758754, 8358f82, d33b195, ef1a818, 33c6f2e, 876d281, b7ddb6e, e20d791, df035ec, 1d382ed, 2d38eb1, 411b0cf, feaa92c, c3b085c, 0dc6925, d03647f, ff5696e, 3e06a9c, 2c73d9f, 82914cf, 1cede5b, 2ff822c, 7a8ac97, 2ef36e2, e7e3520, d765597, e1aab18, ee7e7a1, 2f9bd78, 4889e63, d627f41, 5008537, 747c6f9, 463fa45, 3090405, 5ca1e76, 395d285, e46fbe3, 7ed7343, faa9b41, 78989c0, a99430e, 8e29fe9, 426f64e, e5f2174, fe9ee48, b19ecbf, ed93569, 23631c8, 73715c9, d4c1ca9, a55cced, f17c185, 67a28a4, a9ec0ee, 812545c, 8dc9928, a090907, 086579b, 2952eae, 4a85e11, f64db89, 52221dd, e8f93e8, 3f22469, cd1510d, b7ef951, c4df7e0, 165dc00, bfc2738, 338c068, e2d6089, feb27b8, 3e99adb, cc4a475, 91377a4, 7c3b46f, d6cf631, abcdc5a, 4d303e7, 6aecfe6, 40c2cb2, e42548f, 9042d55, e4e560a, 939188b, cd319f8, fcdf41a, f47c047, 5193fce, 81e1310, b693111, 626c349, acb93ce, 777c4d0, b441156, 30fa554, 33231d2, 7321d67, 57e08e9, 42fb1a1, 46f2f71, 84554d2, aebc48c, 8239ec8, 3f70351, 3c7155f, 7e460e7, 776d06d, 8bfc7b8, c8d3aa2, 3aaf726, 76cf018, af3f80f, 5a494b3, f3df1f2, 5f998eb, 75d003a, 9574f80, c077dbd, ed875b5, 518cdad, f4978fc, f1c6b34, 84dfbf0, bef5eed, 19ebdcf, 37c7952, 5eb7267, 335ed8c, 9477c53, 4b7fbdf, 91601de, c657812, b39eddf, 2cf52df, 996224f, 6e2d7dc, d4a9198, 7b5d414, 6d74373, f8d53c1, b6fe6ff, bb4f4e9, 0ec3610, 83bde3a, 4f5a5c8, bf4e492, f403298, ade0c60, 25307fc, b1ee12f, 2d9f20f, 84f733b, 6a52de8, 0e60b81, 4385d74, 0cff2ca, 99502a7, 54d08f9, 1e39ec6, 47257d7, 4c1dd2e, d1fa5e8, 8c17364, 8b7a1ce, bbadb0b, c815a2b, 0ca6e04, 2cd7740, ffb54e0, dfc9c10, cc66175, 4db2f7e, 16a57c5, 5d9a574, fc5f0f0, ac3ef39, 50cdd0a, 19945d0, 4024407, b96c893, d0eb61d, d4c0f10, bc57f9b, ccae7c4, 1d6ad6d, 1a2556a, 9dbbc51, 3dc26e2, bd32f09, 55a961b, 6f7059e, 04a14a4, 8e6fc15, 6a00eaf, b1e3519, 21180e2, 6b13f2a, f9441c9, 27f3a8f, ee43fda, bf2cb9a, 0feaec7, 451a0c9, f958a1c, a012595, 411c6e0, 7d167d0, 274a0c8, 4487832, 1be6dc0, a1b219f, e27aa04, 860edb9, 716e532, 4983d46, f9b68b6, ca72bd5, e63e15e, b5711f4, a3539b0, 6dd4976, 6967fff, 95a61e8, 70a4864, 5c2619d, 2af06e9, b2a0f1b, 0c3c38a, ab23b56, 63f8f34, 27a6b5b, 8643fec, 7a5dcea, a96bead, 881880f, 8e24ec9, 044fe03, 1a42c04, 398f3ef, 294f902, 5ff3db8, 0758859, baefc89, 2855778, 975cc92, 4e948b4, c60839d, a8d5a78, a6b2c23, 9e558c9, ad6a293, b53fb04, 7adfc58, a930ea7, 9a72533, 16ece09, 67dee62, c3ad665, c35db55, 2834e20, 811269d, 2061686, e6a6ae9, 537db60, a626e8f, 1fb5c96, 0044748, f4a6ab7, 1393db6, 298c4ad, 1788cc9, 6802c0a, 2bfeb33, e2beb7d, 1ef4a2f, 8a29660, 5efcb18, c9050e2, 62f7a49, c03109c, 95a3f1c, 2941336, a4c2081, f449c78, b3159ee, 83974b7, 997b578, 0788041, c154f96, 52b0c8c, 083900d, a14f800 passed successfully.

Branch: origin/feature/doc-7153
Author: Michael Friedrich

[icinga-migration]

Updated by icinga-kanban on 2015-10-02 08:46:58 +00:00

Build !#1080 triggered by the commits 9a28855, c3b5d8a passed successfully.

Branch: origin/master
Author: Michael Friedrich

[icinga-migration]

Updated by elippmann on 2015-10-05 14:11:44 +00:00

• Target Version changed from 2.0.0 to 273

[icinga-migration]

Updated by elippmann on 2015-11-20 13:10:45 +00:00

• Target Version changed from 273 to Backlog

[lippserd]

I close this issue. Our documentation is still not the greatest to be honest :). If there's anything missing, please open a dedicated issue.