openstack
/
freezer
Code Issues Proposed changes

Adds doc8 check to pep8 

This patch adds doc8 check for .rst files to pep8.
Files that fail doc8 check are also fixed.

Ignores D000, D001 of doc8 check. This requires lot of changes
and should be done in a separated patch.

Change-Id: I7d021e6fee3e12feff7c219e09c545da5274c354
This commit is contained in:
Dao Cong Tien 2018-07-12 20:11:52 +07:00
parent 0636058b4f
commit 401256a6e5
16 changed files with 56 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/source/admin/agent-scheduler-install.rst
View File

@ -41,24 +41,24 @@ Install required packages first:
.. code:: bash
sudo apt-get install python-dev python-pip git openssl gcc make automake
sudo apt-get install python-dev python-pip git openssl gcc make automake
Clone proper branch of Freezer Client with git:
.. code:: bash
git clone -b [branch] https://github.com/openstack/freezer.git
git clone -b [branch] https://github.com/openstack/freezer.git
Install requirements with pip:
.. code:: bash
cd freezer/
sudo pip install -r requirements.txt
cd freezer/
sudo pip install -r requirements.txt
Install freezer from source:
.. code:: bash
sudo python setup.py install
sudo python setup.py install

2
doc/source/admin/complete-install.rst
View File

@ -8,4 +8,4 @@ Requirements
------------
Ubuntu / Debian Installation
----------------------------
----------------------------

2
doc/source/admin/freezer-web-ui-install.rst
View File

@ -8,4 +8,4 @@ Requirements
------------
Ubuntu / Debian Installation
----------------------------
----------------------------

3
doc/source/admin/index.rst
View File

@ -5,7 +5,6 @@ Table of Contents:
.. toctree::
:maxdepth: 2
installation
operation

14
doc/source/admin/installation.rst
View File

@ -7,7 +7,7 @@ Agent & Scheduler Installation:
.. toctree::
:maxdepth: 2
agent-scheduler-install
Freezer API Installation
@ -15,21 +15,21 @@ Freezer API Installation
.. toctree::
:maxdepth: 2
freezer-api-install
Web UI Installation
-------------------
.. toctree::
:maxdepth: 2
freezer-web-ui-install
Backup as a Service Platform Installation
-----------------------------------------
.. toctree::
:maxdepth: 2
complete-install
complete-install

2
doc/source/admin/operation.rst
View File

@ -1,4 +1,4 @@
Operation
=========
Here goes operation guides...
Here goes operation guides...

2
doc/source/contributor/jobs.rst
View File

@ -27,7 +27,7 @@ Scheduling information enables future/recurrent execution of jobs
job document structure
.. code-block:: none
.. code-block:: none
"job": {
"job_action": { parameters for freezer to execute a specific action }

2
doc/source/install/get_started.rst
View File

@ -43,4 +43,4 @@ Concepts and definitions
*hostname* is _probably_ going to be the host fqdn.
*backup_id* defined as UUID of a backup.
*backup_id* defined as UUID of a backup.

2
doc/source/user/freezer-scheduler.rst
View File

@ -1,4 +1,4 @@
Scheduler User Guide
====================
Here goes the guide...
Here goes the guide...

2
doc/source/user/freezer-web-ui.rst
View File

@ -1,4 +1,4 @@
Web User Interface User Guide
=============================
Here goes the guide...
Here goes the guide...

3
doc/source/user/index.rst
View File

@ -3,9 +3,8 @@ User Guide
.. toctree::
:maxdepth: 2
installation
freezer-agent
freezer-scheduler
freezer-web-ui

38
doc/source/user/installation.rst
View File

@ -38,33 +38,33 @@ Install required packages first:
.. code:: bash
sudo apt-get install python-dev python-pip git openssl gcc make automake
sudo apt-get install python-dev python-pip git openssl gcc make automake
For python3:
.. code:: bash
sudo apt-get install python3-dev git openssl openssl-devel gcc make automake
sudo apt-get install python3-dev git openssl openssl-devel gcc make automake
Clone proper branch of Freezer Client with git:
.. code:: bash
git clone -b [branch] https://github.com/openstack/freezer.git
git clone -b [branch] https://github.com/openstack/freezer.git
Install requirements with pip:
.. code:: bash
cd freezer/
cd freezer/
sudo pip install -r requirements.txt
sudo pip install -r requirements.txt
Install freezer from source:
.. code:: bash
sudo python setup.py install
sudo python setup.py install
Create ENV file:
@ -115,35 +115,35 @@ Install required packages first:
.. code:: bash
sudo yum install python-devel python-pip git openssl \
openssl-devel gcc make automake
sudo yum install python-devel python-pip git openssl \
openssl-devel gcc make automake
For python3:
.. code:: bash
sudo apt-get install python3-devel git openssl \
openssl-devel gcc make automake
sudo apt-get install python3-devel git openssl \
openssl-devel gcc make automake
Clone proper branch of Freezer Client with git:
.. code:: bash
git clone -b [branch] https://github.com/openstack/freezer.git
git clone -b [branch] https://github.com/openstack/freezer.git
Install requirements with pip:
.. code:: bash
cd freezer/
cd freezer/
sudo pip install -r requirements.txt
sudo pip install -r requirements.txt
Install freezer from source:
.. code:: bash
sudo python setup.py install
sudo python setup.py install
Create ENV file:
@ -214,8 +214,8 @@ After you have installed required packages install pip:
.. code:: bash
easy_install -U pip
pip install freezer
easy_install -U pip
pip install freezer
Freezer scheduler on windows run as a windows service and it needs to be installed as a user service:
@ -223,11 +223,11 @@ Freezer scheduler on windows run as a windows service and it needs to be install
.. code:: bash
whoami
whoami
cd C:\Python27\Lib\site-packages\freezer\scheduler
cd C:\Python27\Lib\site-packages\freezer\scheduler
python win_service.py --username {whoami} --password {pc-password} install
python win_service.py --username {whoami} --password {pc-password} install
Unofficial Installer for Windows
--------------------------------

1
lower-constraints.txt
View File

@ -17,6 +17,7 @@ ddt==1.0.1
debtcollector==1.19.0
decorator==4.2.1
deprecation==2.0
doc8==0.6.0
docutils==0.14
dogpile.cache==0.6.5
dulwich==0.19.0

2
specs/tenant_based_backups.rst
View File

@ -8,7 +8,7 @@ Blueprint URL:
Problem description
===================
As a tenant, I need to use Freezer to backup all my data and metadata from an OS Cloud and restore it
at my convenience. With this approach all the data can be restored on the same Cloud platform (in case anything went lost) or on an independent cloud (i.e. a new one freshly deployed on a different geographic location).
at my convenience. With this approach all the data can be restored on the same Cloud platform (in case anything went lost) or on an independent cloud (i.e. a new one freshly deployed on a different geographic location).
Tenants needs to backup selectively all their resources from a the OS services.
These resources/services are:

4
test-requirements.txt
View File

@ -19,3 +19,7 @@ tempest>=17.1.0 # Apache-2.0
# Used in integration tests
python-openstackclient>=3.12.0 # Apache-2.0
# Used in doc8 check
doc8>=0.6.0 # Apache-2.0
Pygments>=2.2.0 # BSD license

8
tox.ini
View File

@ -77,7 +77,9 @@ commands =
[testenv:pep8]
commands = flake8 freezer
commands =
flake8 freezer
doc8 {posargs}
[testenv:pylint]
commands = pylint --rcfile .pylintrc freezer
@ -88,6 +90,10 @@ show-source = True
enable-extensions = H203,H106
exclude = .venv,.tox,dist,doc,test,*egg,releasenotes
[doc8]
ignore = D000,D001
ignore-path = .venv,.git,.tox,.tmp,*freezer/locale*,*lib/python*,freezer.egg*,doc/build,releasenotes/*,doc/source/contributor/api
[testenv:releasenotes]
commands = sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html