From ee7dd47a3b78adce8ace53f95b8e70a35b124fdf Mon Sep 17 00:00:00 2001 From: Vincent CARDON Date: Fri, 20 Nov 2020 14:52:00 +0100 Subject: [PATCH] =?UTF-8?q?Mise=20=C3=A0=20jour=20de=20'README.md'?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 56 ++++--------------------------------------------------- 1 file changed, 4 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index b316a0c..68dbc93 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,6 @@ -TIS-backup Documentation -======================== - -This is the documentation repository of the TIS-backup project. +This is the repository of the TIS-backup project, licensed under GPLv3. The documentation is provided under the license 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 multi-branche 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. +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