Skip to content

Commit 44d11a6

Browse files
authored
Redirect to new repo
Add a note in README.md to point to the new repo for documentation
1 parent b0040a8 commit 44d11a6

1 file changed

Lines changed: 6 additions & 54 deletions

File tree

README.md

Lines changed: 6 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -3,57 +3,9 @@ OpenNebula Documentation
33

44
![Make Html](https://github.com/OpenNebula/docs/actions/workflows/make_html.yml/badge.svg)
55

6-
This is the official repository of OpenNebula's Documentation. This
7-
documentation is live at:
8-
[http://docs.opennebula.org](http://docs.opennebula.org).
9-
10-
You are encouraged to fork this repo and send us pull requests!
11-
12-
To create issues to report changes and requests, please use the [OpenNebula main repository](https://github.com/OpenNebula/one), with label Documentation.
13-
14-
Building
15-
--------
16-
17-
`Graphviz <https://graphviz.org/>` is needed to compile the documentation.
18-
19-
Also the following Python dependencies:
20-
21-
``pip install 'sphinx<7.3' sphinx_rtd_theme sphinx-prompt sphinxcontrib-spelling pyyaml sphinx-substitution-extensions``.
22-
23-
Build the documentation by running ``make html``.
24-
[More information](http://sphinx-doc.org/).
25-
26-
Spell checking
27-
-------------
28-
29-
`sphinxcontrib.spelling <https://sphinxcontrib-spelling.readthedocs.io/en/latest/index.html` is needed to run the spell checker.
30-
31-
Also, the following Python dependencies:
32-
``pip install sphinxcontrib-spelling pyenchant``
33-
34-
And the `python3-enchant package`:
35-
``sudo apt install python3-enchant``
36-
37-
If the spellchecker job fails for your branch, you can check the job log which will display the file + word that didn't pass the spell checker along with some suggestions.
38-
Either you will have to correct the typo and push it again, or if it's a false positive, you can update the custom wordlist used at `source/ext/spellchecking/wordlists/opennebula.txt`
39-
40-
Translations
41-
------------
42-
43-
### Bootstrap a new language
44-
45-
$ make gettext
46-
$ sphinx-intl update -c source/conf.py -p build/locale -l <lang>
47-
48-
### Translate
49-
50-
Translate your po files under ``./locale/<lang>/LC_MESSAGES/``.
51-
52-
### Publish the translation
53-
54-
$ sphinx-intl build -c source/conf.py
55-
$ make -e SPHINXOPTS="-D language='<lang>'" html
56-
57-
### More Info
58-
59-
Follow [this guide](http://sphinx-doc.org/intl.html) for more information.
6+
> ⚠️ **Maintenance Notice**
7+
>
8+
> This repository is now in **maintenance mode**. All official documentation has been migrated to the new repository:
9+
> 👉 [https://github.com/OpenNebula/website](https://github.com/OpenNebula/website)
10+
>
11+
> Please refer to the new repository for the latest content, updates, and contributions.

0 commit comments

Comments
 (0)