Fix most of the comments reported in #22

- Except the ones related to path.

CONTRIBUTING.rst

@@ -1,5 +1,5 @@
 If you would like to contribute to the development of this project.
 
-Submit your pull request and issues to https://github.com/uggla/python-redfish .
+Submit your pull request and issues to https://github.com/bcornec/python-redfish.
 
 You can also share and discuss on the mailing list as well.

README.rst

@@ -20,14 +20,17 @@ Project Structure
 This project follows the same convention as OpenStack projects, eg. using pbr
 for build and test automation::
 
-    doc/            # documentation
-    doc/source      # the doc source files live here
-    doc/build/html  # output of building any docs will go here
+    doc/            # Documentation
+    doc/source      # The doc source files live here
+    doc/build/html  # Output of building any docs will go here
     dmtf            # Reference documents and mockup provided by the DMTF
-    examples/       # any sample code using this library, eg. for education
+    examples/       # Any sample code using this library, eg. for education
                     # should be put here
-    redfish/        # the redfish library
-    redfish/tests/  # python unit test suite
+    pbconf          # Project builder file to build rpm/deb packages for
+                    # distributions
+    redfish/        # The redfish library itself
+    redfish/tests/  # Python redfish unit test suite
+    redfish-client  # Client tool to manage redfish devices
 
 Requirements
 ------------
@@ -44,7 +47,7 @@ running the unit test suite are listed in test-requirements.txt.
 Get the sources
 ---------------
 
-The sources are available on github and can be retrieve using::
+The sources are available on github and can be retrieved using::
 
     git clone https://github.com/uggla/python-redfish
 
@@ -68,11 +71,4 @@ Distribution list: python-redfish@mondorescue.org
 Further References
 ------------------
 
-The specification can be found here :
- http://www.dmtf.org/sites/default/files/standards/documents/DSP0266_1.0.1.pdf
-
-The data model documentation can be found here:
- http://redfish.dmtf.org/schemas/
-
-The overall protocol documentation can be found here:
- http://www.dmtf.org/standards/redfish
+Please look at `dmtf/README.rst <further_ref.html>`_ file.

dmtf/README.rst

@@ -2,11 +2,25 @@ DMTF Redfish specification
 --------------------------
 
 This directory contains the current references from the DMTF on the Redfish
-specification (1.0.0 at the time of the writing)
+specification (1.0.1 at the time of the writing)
+
+The overall protocol documentation can be found online at:
+ http://www.dmtf.org/standards/redfish
+
+The specification can be found locally in DSP0266_1.0.1.pdf or online at:
+ http://www.dmtf.org/sites/default/files/standards/documents/DSP0266_1.0.1.pdf
+
+The data model documentation can be found locally in DSP8010_1.0.0.zip or online at:
+ http://redfish.dmtf.org/schemas/
+
+
 In order to ease test, the DMTF has published a mockup environment to simulate
 a Redfish based system so it is possible to write programs without real Redfish
 compliant hardware platform.
 
+Note: Mockup release is still 0.99.0a and so not aligned with specification realease
+number.
+
 Docker container
 ----------------
 

doc/source/conf.py

@@ -48,7 +48,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'python-redfish'
-copyright = u'2015, Bruno Cornec, Vincent Misson, René Ribaud'
+copyright = u'2015-2016, Bruno Cornec, Vincent Misson, René Ribaud'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

doc/source/further_ref.rst

@@ -0,0 +1,3 @@
+:orphan:
+
+.. include:: ../../dmtf/README.rst

doc/source/installation.rst

@@ -25,7 +25,7 @@ Using pip and virtualenv
 
  Fedora 22::
 
-    dnf install python-virtualenv.noarch python-virtualenvwrapper.noarch
+    dnf install python-virtualenv python-virtualenvwrapper
 
  Ubuntu 15.04::
 
@@ -69,7 +69,7 @@ The mechanism is based on `project builder <http://www.project-builder.org/>`_ t
 #. Follow `get the sources <http://pythonhosted.org/python-redfish/readme.html#get-the-sources>`_ section to retrieve the sources.
 #. Download project builder for your distribution from ftp://ftp.project-builder.org.
 #. Clone the project to your own github account.
-#. Create a .pbrc with the following containt::
+#. Create a .pbrc with the following content, replace "/wokspace/python/redfish" and "uggla" with your own directory and account::
 
     [uggla@ugglalaptop ~]$ cat .pbrc
     pbdefdir python-redfish = $ENV{'HOME'}/workspace
@@ -80,6 +80,10 @@ The mechanism is based on `project builder <http://www.project-builder.org/>`_ t
 
     pb -p python-redfish sbx2pkg
 
+ or::
+
+    pb -p python-redfish sbx2pkg2ins
+
 #. All packages (srpm/rpm) should be available into the build directory, then install the package using rpm::
 
     rpm -Uvh python-redfish/build/RPMS/python-redfish-devel20160213182552.rpm
@@ -90,7 +94,7 @@ The mechanism is based on `project builder <http://www.project-builder.org/>`_ t
 Using deb package
 -----------------
 
-This installation in yet possible due to missing deb package dependencies. We are working on it.
+This installation in not yet possible due to missing deb package dependencies. We are working on it.
 
 In the meantime we recommend to use `Using pip`_ or `Using pip and virtualenv`_.
 
@@ -216,7 +220,7 @@ If you want to build the documentation in pdf.
 
 #. Get texlive full distribution, ex on Fedora::
 
-    dnf install texlive-scheme-full.noarch
+    dnf install texlive-scheme-full
 #. Build the documentation::
 
     make latexpdf

doc/source/usage.rst

@@ -15,10 +15,10 @@ example/simple-proliant.py provide a simple library usage to interact with a HP
 proliant BL460C G9 server. However this example should work on any server supplier following redfish
 standard.
 
-refish-client usage
--------------------
+redfish-client usage
+--------------------
 
-The clint usage can be display using::
+The client usage can be display using::
 
     redfish-client.py -h