This repository has been archived by the owner on Oct 27, 2021. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add deprecation notice and point people to the new docs
- Loading branch information
Showing
2 changed files
with
26 additions
and
23 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,27 +1,10 @@ | ||
# The Graylog documentation | ||
[![Build Status](https://travis-ci.org/Graylog2/documentation.svg?branch=2.2)](https://travis-ci.org/Graylog2/documentation) | ||
# The Graylog Documentation | ||
|
||
## Building locally | ||
Note | ||
==== | ||
|
||
Create and enter the Python virtual environment: | ||
We published the last version of Graylog Documentation before the release of Graylog 4.2. Now, all documentation and help content for Graylog products are available at https://docs.graylog.org/. If you are looking for previous versions of the Graylog documentation, go to: https://archivedocs.graylog.org/ | ||
|
||
# virtualenv . | ||
# source ./bin/activate | ||
**There will be no further updates to this repository as of October 2021.** | ||
|
||
Install [Sphinx](http://sphinx-doc.org), [the theme we are using](https://github.com/snide/sphinx_rtd_theme), and [sphinx-autobuild](https://github.com/GaretJax/sphinx-autobuild): | ||
|
||
# pip install -r requirements.txt | ||
|
||
Build the static documentation and open them in your browser: | ||
|
||
# make html | ||
# open _build/html/index.html | ||
|
||
Build the documentation and automatically build them on any change: | ||
|
||
# make livehtml | ||
# open http://127.0.0.1:8000/ | ||
|
||
### Fedora Linux 22 and higher | ||
|
||
# sudo dnf install -y python-sphinx python-sphinx_rtd_theme | ||
Do you have questions about our documentation? You can no longer post issues in this repository. However, you may place comments or start discussions about documentation here: https://community.graylog.org/c/documentation-campfire/30 |
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 |
---|---|---|
@@ -0,0 +1,20 @@ | ||
{% extends "!layout.html" %} | ||
|
||
<div role="main" data-yolo="1"> | ||
{% block document %} | ||
<div class="admonition note"> | ||
<p class="admonition-title">Deprecation Note</p> | ||
<p> | ||
We published the last version of Graylog Documentation before the release of Graylog 4.2. | ||
Now, all documentation and help content for Graylog products are available at | ||
<a target="_blank" href="https://docs.graylog.org/">https://docs.graylog.org/</a>. | ||
</p> | ||
<p><strong>There will be no further updates to these pages as of October 2021.</strong></p> | ||
<p> | ||
Do you have questions about our documentation? You may place comments or start discussions | ||
about documentation here: | ||
<a target="_blank" href="https://community.graylog.org/c/documentation-campfire/30">https://community.graylog.org/c/documentation-campfire/30</a></p> | ||
</div> | ||
{% block body %}{% endblock %} | ||
{% endblock %} | ||
</div> |