Skip to content
This repository has been archived by the owner on Oct 27, 2021. It is now read-only.

Commit

Permalink
Add deprecation notice and point people to the new docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bernd committed Oct 26, 2021
1 parent b05bc8d commit 2769a8b
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 98 deletions.
104 changes: 6 additions & 98 deletions README.md
@@ -1,102 +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

## Architecture
Note
====

This is the repository that is used to create [docs.graylog.org](http://docs.graylog.org) running at [readthedocs](https://readthedocs.org/). After changes are pushed to the specific branches, the new pages are built automatically. When the build runs without error, the new pages are available after some minutes.
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/

The typical workflow to make changes to the documentation and preview them before you push the changes to this repository needs the following preparation.

- clone the repository (to your workplace)
- initialize the virtual environment for python
- install the required python packages

After the above is done, changes can be made and previewed with the following

- create git branch for your changes
- change to the virtual environment
- make the modifications/additions
- run the build and check for errors
- push the branch to GitHub and create a pull request

Now a review of the changes is needed and, finally, it will be merged by the reviewer into the branch/version of the documentation you created the pull request for. Should the change be available in other versions of the documentation this should be written in the pull request that the reviewer can push this to the specific versions too.


## Building locally

### required software

- git
- python (including pip)
- virtualenv (`pip install virtualenv`)
- make
- browser (to preview)

#### Mac & Linux

It is very likely that you already have all needed software available. If not we recommend [homebrew](https://brew.sh/) for Mac and the package manager of the Linux distribution you are using.

##### first time preparation

Clone the repository to your workbench:

# git clone https://github.com/Graylog2/documentation.git


Create and enter the python virtual environment:

# cd documentation
# virtualenv .
# source ./bin/activate

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


#### Windows

For Windows we recommend [chocolatey](https://chocolatey.org/) to install the requirements. If that is not possible to use, download and install the software from the project webpages.

##### Windows Installation in detail

_This can not be a complete guide, but this might give you some guidance._

Installation the needed software using [chocolatey](https://chocolatey.org/). Github Desktop and Notepad+ are optional, but a good addition. The commands need to be run in your administrator Powershell.

# choco install python
# choco install git
# choco install make
# choco install github-desktop
# choco install notepadplus

Use the Github Desktop application to clone the repository, by default this can be found in `C:\Users\$USERNAME\Documents\GitHub\$REPONAME`. Or you run `git clone https://github.com/Graylog2/documentation.git` in your **Workbench** directory.

Open Powershell at this location and enable your user to run scripts:

# Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Bypass -Force;

Use the python package manager `pip` to install `virtulenv`. Create the virtual environment, change into the environment and install all requirements:

# pip install virtualenv
# virtualenv .
# .\Scripts\activate
# pip install -r requirements.txt

Once the above is done you are prepared to contribute to the documentation and preview the work live in your local browser. See the daily usage chapter.

### daily usage

How to work with git, create branches and push them will not be covered in this document. Change into the prepared directory, update the sources ([git pull](https://git-scm.com/docs/git-pull)), change into the virtual python environment (Linux/Mac `source ./bin/active`, Windows `.\Scripts\activate`) and start making the changes.

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/
**There will be no further updates to this repository as of October 2021.**

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
20 changes: 20 additions & 0 deletions _templates/layout.html
@@ -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>

0 comments on commit 2769a8b

Please sign in to comment.