diff --git a/README.md b/README.md index 68dbc93..3b2e505 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ -This is the repository of the TIS-backup project, licensed under GPLv3. -The documentation is provided under the license CC-BY-SA. +This is the repository of the TISBackup project, licensed under GPLv3. TISBackup is a python script that the backup server runs at regular intervals to retrieve different data types on remote hosts -such as database dumps, files, virtual machine images and metadata. \ No newline at end of file +such as database dumps, files, virtual machine images and metadata. + +:ref:`Tranquil IT ` is the original author of TISBackup. + +The documentation is provided under the license CC-BY-SA and can be found +on `readthedoc `_. diff --git a/doc/README.md b/doc/README.md deleted file mode 100644 index 5d95a15..0000000 --- a/doc/README.md +++ /dev/null @@ -1,50 +0,0 @@ -TIS-backup Documentation -======================== - -This is the documentation repository of the TIS-backup project. The documentation is provided under the licence CC-BY-SA. - -How to contribute? -================== - -You must install documentation tools and requirements before doing anything : - -```bash -sudo sh ./install_requirements.sh -``` - -Once installed, pre-commit checks (lint/syntax) are launched prior to committing your changes. To launch tests manually, you can run the following : - -```bash -pre-commit run --all-files -``` - -This should (take a while because sphinx-build) return : - -```bash -Trim Trailing Whitespace.................................................Passed -Fix End of Files.........................................................Passed -rst ``code`` is two backticks............................................Passed -sphinx build.............................................................Passed -``` - - -How to push documentation to public ? -===================================== - -Pushing the documentation through a rsync is bad. - -To publish WAPT documentation to public, a 'release-' tag must be set using git. - -Once a release tag has been set, it creates a tagged build which must be launched manually in Jenkins. - -```bash -git add * -git commit -m 'I have checked it builds without errors, trust me' -git push -git tag -a release-1.8.1.6694-doc -m "WAPT documentation publish for 1.8.1.6694" -git push origin --tags -``` - -Once that tag has been pushed, in Jenkins you have to re-scan the multibranches project and go to `Tags` tab, select your tag and build it. - -Wait for the entire build to go through, it will publish everything according to JenkinsFile procedure. diff --git a/doc/source/tranquil-it-contacts.rst b/doc/source/tranquil-it-contacts.rst index 3bfed41..e6ffbb0 100644 --- a/doc/source/tranquil-it-contacts.rst +++ b/doc/source/tranquil-it-contacts.rst @@ -8,18 +8,12 @@ .. meta:: :description: Contacting Tranquil IT :keywords: WAPT, documentation, website, editor, - Twitter, Linkedin, Forum, Mailing List, official website + Twitter, official website .. _contact_tranquil_it: Contacting Tranquil IT ====================== -Contact us for more informations: - * Tranquil IT: https://www.tranquil.it/ * Twitter: https://twitter.com/tranquil_it -* Linkedin: https://www.linkedin.com/company/tranquil-it -* Forum in French: https://forum.tranquil.it/ -* Forum in English: https://www.reddit.com/r/WAPT -* Mailing-list: https://lists.tranquil.it/listinfo/wapt