Commit Graph

343 Commits

Author SHA1 Message Date
lippserd 4cadc90c92 Merge pull request #2972 from Icinga/feature/enhance-docs-add-missing-bits
Enhance the documentation, add missing bits and fix outdated information
2017-09-29 11:15:17 +02:00
Michael Friedrich 34bd8e14c3 Enhance the documentation and fix outdated information (preferences, etc.)
This applies a new structure for the main doc/ and modules/*/doc tree with

01-About.md
02-Installation.md
...

This allows us to link from the main doc directory into module specific
documentation entries.

Furthermore table formatting, examples, and missing settings have been added
where applicable.

This patch also takes care about proper URL anchors and file names and directories.

fixes #2950
2017-09-29 11:01:37 +02:00
Eric Lippmann 3790fd0819 Bump version to 2.4.2
(cherry picked from commit 13e86b6320)
Signed-off-by: Eric Lippmann <eric.lippmann@icinga.com>
2017-09-28 14:24:00 +02:00
Eric Lippmann c4e236cce9 Doc: Fix header anchor detection 2017-07-28 10:20:18 +02:00
Eric Lippmann 68842f00d8 Fix version 2017-05-03 15:12:07 +02:00
Johannes Meyer 181e2ef05c Swag: Fix swag (aka a whole bunch of code style issues..) 2017-01-27 14:48:59 +01:00
Johannes Meyer 0716f87852 Update german translation 2016-12-13 13:57:27 +01:00
Eric Lippmann ff71a395d2 Update version to 2.4.0 2016-12-13 12:34:12 +01:00
Eric Lippmann 65f0a4683f Doc: Allow to view documentation of disabled modules
fixes #13387
2016-12-02 15:21:58 +01:00
Eric Lippmann 875d42c0a6 Revert "Merge branch 'bugfix/always-use-the-jquery-find-method-w/-node-context-10704'"
This reverts commit f517c62fde, reversing
changes made to d1fd7e4be7.

refs #10704
2016-11-21 14:34:58 +01:00
Eric Lippmann f517c62fde Merge branch 'bugfix/always-use-the-jquery-find-method-w/-node-context-10704'
fixes #10704
2016-11-21 14:33:43 +01:00
Alexander A. Klimov 3363e6795f JS: use $(parent).find(child) instead of $(child, parent)
refs #10704

Signed-off-by: Eric Lippmann <eric.lippmann@icinga.com>
2016-11-21 10:46:31 +01:00
Eric Lippmann f05d22a39d Fix image in the documentation of the monitoring module 2016-09-01 11:30:58 +02:00
Eric Lippmann fc5ed3feb1 Bump version to 2.3.4 2016-06-23 14:09:55 +02:00
Eric Lippmann d4b9b6d303 Bump version to 2.3.3 2016-06-07 15:15:01 +02:00
Alexander A. Klimov 21e4ba5680 Icinga Web 2.3.2 2016-04-28 14:56:31 +02:00
Eric Lippmann fdbcc6af8e Bump version to 2.3.1 2016-04-18 01:10:20 +02:00
Eric Lippmann 773c3cc88e Bump version to 2.3.0 2016-04-13 16:23:38 +02:00
Eric Lippmann 5f8611ffe5 doc: Support fragment-less file links 2016-04-13 16:18:27 +02:00
Eric Lippmann 0461b060f8 Fix typo in doc/module.less 2016-04-13 15:33:19 +02:00
Eric Lippmann 0a162008a2 Increase font-weight of links in docs 2016-04-13 15:28:08 +02:00
Eric Lippmann 04a3d3e90d Fix issue w/ duplicate section IDs
fixes #11580
2016-04-13 14:49:34 +02:00
Eric Lippmann 42112b28c5 Revert "doc: Replace whitespaces with - for section IDs"
This reverts commit 82d36e11cc.
2016-04-13 14:41:27 +02:00
Eric Lippmann b0e3dd438f Doc: Fix too greedy regex for matching blockquotes 2016-04-12 11:11:41 +02:00
Eric Lippmann 48cd99aba3 doc: Render chapter tab titles human readable 2016-04-01 14:38:23 +02:00
Eric Lippmann 3ecf390a4b doc: Use module name for tab and window title 2016-04-01 14:36:11 +02:00
Eric Lippmann 38892a971f doc: Support loading images beneath doc/ directories 2016-04-01 14:32:33 +02:00
Eric Lippmann f9b7c302fc doc: Update bullets in toc 2016-03-31 17:38:34 +02:00
Eric Lippmann 2667457eec doc: Don't fail on duplicate IDs 2016-03-30 15:31:53 +02:00
Marius Hein 609b2da565 Update module versions 2016-02-29 22:49:40 +01:00
Alexander A. Klimov 474803fee4 Change all license headers to only reflect a file's year of creation
refs #11000
2016-02-08 15:41:00 +01:00
Eric Lippmann 3e543808c1 Doc: Add tabs where missing 2016-01-12 08:52:30 +01:00
Eric Lippmann b61a436495 doc: Remove h1 from toc 2016-01-12 08:52:30 +01:00
Eric Lippmann 3d9b878817 doc: Remove h1 from index 2016-01-12 08:52:30 +01:00
Eric Lippmann 8131046b8d doc: Add missing class .chapter 2016-01-12 08:52:30 +01:00
Eric Lippmann 5b38fd7ff8 Doc: Underline links 2016-01-12 08:52:30 +01:00
Eric Lippmann a20e971e38 Doc: Remove hover effects from tables 2016-01-12 08:52:30 +01:00
Eric Lippmann 3c236e820c Doc: Color toc numbers
refs #8487
2016-01-12 08:52:30 +01:00
Eric Lippmann 930f014661 Doc: Simplify CSS gradient mixin 2016-01-12 08:52:30 +01:00
Eric Lippmann 4a002af0b9 Doc: Number headings when displaying chapters
refs #8487
2016-01-12 08:52:30 +01:00
Eric Lippmann 85c477e577 Doc: Add tabs 2016-01-12 08:52:30 +01:00
Eric Lippmann 313a02d9f0 Doc: Number headings in toc
refs #8487
2016-01-12 08:52:30 +01:00
Eric Lippmann a63dd58b6a Doc: Increase readability of search matches 2016-01-12 08:52:30 +01:00
Eric Lippmann c5dba1fd76 Doc: Increase font size 2016-01-12 08:52:30 +01:00
Eric Lippmann 353b9da8a5 Bump version to 2.1.2 2015-12-23 14:21:56 +01:00
Eric Lippmann 405b768dc2 Bump version to 2.1.1 2015-12-22 14:50:13 +01:00
Eric Lippmann dad9538496 Doc: Fix detection whether documentation is empty 2015-12-21 11:09:20 +01:00
Eric Lippmann 11e7d1050f Merge branch 'bugfix/line-breaks-in-comments-10603'
fixes #10603
2015-12-21 09:39:12 +01:00
Eric Lippmann e3c1734d1a doc: Use Util/DirectoryIterator 2015-11-24 16:10:45 +01:00
Eric Lippmann 43e0d037bf Add blockquote to the style guide 2015-11-23 11:38:13 +01:00
Eric Lippmann 668ea95f1a doc: Add comment-list to the design guidelines 2015-11-20 15:14:01 +01:00
Eric Lippmann c0f1d6da33 doc: Add toc to design guidelines 2015-11-20 11:22:27 +01:00
Eric Lippmann fad52e0929 Update version 2015-11-16 15:34:47 +01:00
Thomas Gelf 4ce131e9ec doc: show full tabs if any 2015-11-13 11:19:43 +01:00
Thomas Gelf 2f8f3fdd90 doc/css: no outline for a[name]
I'd however prefer to have them in the h1 tag. Or even around the h1,
that's legal since HTML5. Or, best variant: an id on the element. A
common prefix, and no worries about duplicates: we never show content
in multiple columns.
2015-11-13 09:41:28 +01:00
Thomas Gelf 5324875ab6 DocTocRenderer: no anchor for toplevel entries
Makes links look better and hides anchor-encoding issues at least on
top level
2015-11-13 09:37:02 +01:00
Thomas Gelf d7a9a55ad6 style/guide: add js to get rid of styles 2015-11-06 01:52:04 +01:00
Eric Lippmann 54bb99a96d Merge branch 'feature/dope-layout-5543'
refs #5543
2015-10-02 11:16:35 +02:00
Eric Lippmann 359dde708c Prepare 2.0.0 release 2015-10-01 23:39:27 +02:00
Eric Lippmann 3f867437c4 doc/CSS: Reset some styles
refs #5543
2015-10-01 02:58:54 +02:00
Eric Lippmann c19e850df3 Fix erroneous CSS statements 2015-09-03 16:58:36 +02:00
Eric Lippmann 31cb1ceb93 doc: Fix PHPDoc of IcingawebController::getPath() 2015-08-27 14:40:49 +02:00
Eric Lippmann 7ea559e6be doc: Namespace the IcingawebController
refs #5786
2015-08-27 14:40:10 +02:00
Eric Lippmann 2f1d6d7a95 doc: Add PHPDoc to IndexController 2015-08-27 14:40:10 +02:00
Eric Lippmann 77b9881a38 doc: Namespace IndexController
refs #5786
2015-08-27 14:40:02 +02:00
Eric Lippmann 26c403832e doc: Namespace the ModuleController
refs #5786
2015-08-27 14:36:26 +02:00
Eric Lippmann 66e50ad341 doc: Remove unused alias in the ModuleController
Thanks for not reviewing commits!
2015-08-27 14:35:26 +02:00
Eric Lippmann ad389d1696 doc: Fix PHPDoc of SearchController::getWebPath() 2015-08-27 14:24:25 +02:00
Eric Lippmann f0f24bee94 doc: Namespace the SearchController
refs #5786
2015-08-27 14:23:35 +02:00
Eric Lippmann 8981f2cc26 doc: Optimize imports in the SearchController 2015-08-27 14:22:59 +02:00
Eric Lippmann 5fadb647e2 doc: Namespace the StyleController
refs #5786
2015-08-27 14:22:35 +02:00
Eric Lippmann f1a63a36f5 doc: Support header-less sections 2015-08-11 09:20:56 +02:00
Eric Lippmann 82d36e11cc doc: Replace whitespaces with - for section IDs
Fixes jQuery selector issues when jumping to an anchor.
2015-08-11 09:20:56 +02:00
Eric Lippmann 4e3fbb1341 doc: Support setext-style only headers
Setext-style used to work before too but only if an atx-style header comes first.
2015-08-11 09:20:56 +02:00
Matthias Jentsch f8e2dc850c Drop IniEditor and clean up IniWriter
Replace the ini editor code with a new parser implementation that manipulates a DOM. Do not support capabillities that are no longer needed, like nested configurations, section inheritance, section-less properties.
2015-08-05 18:10:17 +02:00
Eric Lippmann 5ae21fd196 doc: Set parameters from route explicitly
refs #9817
2015-08-04 12:48:53 +02:00
Eric Lippmann 5c5dea616d doc: Use Params::getRequired() in ModuleController
refs #9644
2015-07-28 13:59:59 +02:00
Eric Lippmann 794e4a1e1e doc: Use Params::getRequired() in IcingawebController
refs #9644
2015-07-28 13:59:39 +02:00
Eric Lippmann 9a758f3ed9 doc: Use Controller::httpNotFound() in SearchController
refs #9644
2015-07-28 13:47:25 +02:00
Eric Lippmann 9846dfb2e2 doc: Use Controller:httpNotFound() in ModuleController
refs #9644
2015-07-28 13:47:06 +02:00
Eric Lippmann 7cfc78558d Merge branch 'master' into feature/secure-modules-9644
Conflicts:
	library/Icinga/Exception/IcingaException.php
2015-07-28 13:42:02 +02:00
Eric Lippmann d850cffa42 doc: Remove unnecessary use in SearchController
refs #9449
2015-07-28 11:55:27 +02:00
Eric Lippmann b3f463a7a5 doc: Remove unnecessary use in ModuleController
refs #9449
2015-07-28 11:54:55 +02:00
Eric Lippmann e70fb76d31 doc: Remove unnecessary use in IcingawebController
refs #9449
2015-07-28 11:54:00 +02:00
Eric Lippmann 07fb82357b doc: Make documentation for all installed modules avaiable
Before, only documentation of enabled modules was available.

refs #9644
2015-07-27 15:19:32 +02:00
Thomas Gelf 3462f0ee9a Merge remote-tracking branch 'origin/master' into feature/refine-ui-for-rc1-9361
Conflicts:
	modules/monitoring/application/views/scripts/host/history.phtml
	modules/monitoring/application/views/scripts/list/services.phtml
2015-06-18 11:26:51 +02:00
Matthias Jentsch f31f18dc51 Move security documentation for monitoring module into correct directory
refs #9377
2015-06-16 17:54:21 +02:00
Matthias Jentsch 5b8c308679 Merge branch 'bugfix/use-statement-error-9281'
fixes #9281
2015-06-16 17:06:47 +02:00
Matthias Jentsch 5bf7bbdb8b Remove unneeded use statements from global namespaces
Use statements on global classes from the global namespace don't have any effect, prevent warnings from being displayed in php versions >= 5.6.9 and version >= 5.5.25.

refs #9281
2015-06-16 16:10:52 +02:00
Thomas Gelf 5df2edee09 doc/style/guide: add action table
Problem: CSS in doc module is not "clean" as it has custom styling
2015-06-15 23:31:37 +02:00
Matthias Jentsch ea85254cc5 Fix typos and formatting in documentation
refs #9377
2015-06-15 11:09:41 +02:00
Matthias Jentsch 3eb4561f79 Merge branch 'feature/permission-restriction-documentation-9377'
fixes #9377
2015-06-10 19:04:47 +02:00
Matthias Jentsch edd1c2a1f3 Move monitoring permission documentation into a separate module
refs #9377
2015-06-10 18:43:54 +02:00
Alexander A. Klimov 6e045b6239 Change version in modules/*/module.info to 2.0.0-rc1
refs #7651
2015-06-08 13:19:46 +02:00
Alexander A. Klimov 05b7c3aa6a Replace <h1> w/ <h2>
refs #8847
2015-06-05 16:01:37 +02:00
Alexander A. Klimov 6dedb48444 Indicate that nothing was found in the docs when searching
refs #8847
2015-06-05 15:37:31 +02:00
Johannes Meyer 7b9983de38 Merge the menu entries for users, groups and roles into "Authentication" 2015-06-01 17:16:24 +02:00
Johannes Meyer c7ce1498bf Introduce menu entry "Configuration" 2015-06-01 16:10:23 +02:00
Johannes Meyer 6b3dd63bb3 Doc module: Fix div.controls of the index controller's index action
refs #7876
2015-04-20 14:55:18 +02:00
Alexander A. Klimov 20b09d3bda Inherit from Icinga\Web\Controller rather than from Icinga\Web\Controller\ModuleActionController 2015-04-08 15:13:59 +02:00