Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update the README and point the doc to the Wiki
- Loading branch information
Showing
6 changed files
with
4 additions
and
859 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,5 @@ | ||
# Zentral | ||
|
||
Read the Wiki for Zentral overview and documentation: <https://github.com/zentralopensource/zentral/wiki> | ||
|
||
For final documentation please bookmark: <http://zentral.readthedocs.org/en/latest/> | ||
- we currently work on migrating the doku to readthedocs. | ||
|
||
Zentral is a framework to gather, process, and monitor system events and link them to an inventory. | ||
|
||
Check out the [Wiki](https://github.com/zentralopensource/zentral/wiki) to get and overview of the project and for the documentation. This is where the [release notes](https://github.com/zentralopensource/zentral/wiki/release-notes) are published too. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,3 @@ | ||
# Zentral's documentation | ||
# Zentral documentation | ||
|
||
(these instructions are adapted from the excellent [django/docs](https://github.com/django/django/blob/master/docs/)) | ||
|
||
The documentation in this tree uses [Markdow]('https://github.com/rtfd/recommonmark') and the [Sphinx documentation system](http://sphinx-doc.org/). | ||
This allows it to be built into other forms for easier viewing and browsing. | ||
|
||
To generate the HTML version of the docs: | ||
|
||
* Install Sphinx and recommonmark (using ``pip install Sphinx recommonmark`` or some other method) | ||
|
||
* In this directory, use the command ``make html`` (or ``make.bat html`` on Windows) | ||
|
||
The documentation in _build/html/index.html can then be viewed in a web browser. | ||
Check out the [Wiki](https://github.com/zentralopensource/zentral/wiki). |
Oops, something went wrong.