From 3d941108d8e0c63b14792defc98332dbfec1a735 Mon Sep 17 00:00:00 2001 From: sae8055 Date: Wed, 25 Mar 2015 21:27:11 +0100 Subject: [PATCH] Change the documentation to reference Redfish specification. Remove HP and iLO specific references --- README.md | 16 ++++++++-------- docs/Managing_HP_Servers_Using_RESTful_API.md | 2 -- docs/Redfish_API_Data_Model.md | 2 ++ docs/Redfish_Specification_Documentation.md | 2 ++ docs/iLO_4_REST_API_Data_Model.md | 2 -- 5 files changed, 12 insertions(+), 12 deletions(-) delete mode 100644 docs/Managing_HP_Servers_Using_RESTful_API.md create mode 100644 docs/Redfish_API_Data_Model.md create mode 100644 docs/Redfish_Specification_Documentation.md delete mode 100644 docs/iLO_4_REST_API_Data_Model.md diff --git a/README.md b/README.md index 71b8a57..73d5e99 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ -# python-proliant-sdk -This repository will be used to house the Python ProLiant SDK. This SDK will be used to help Python developers communicate with the [HP ProLiant REST API](http://hp.com/go/restfulapi). +# python-redfish +This repository will be used to house the Redfish python library. This library will be used to help Python developers communicate with the [Redfish API](http://www.redfishspecification.org/). ## Directory Structure -- **docs** - Links to documents discussing the HP RESTful API -- **examples** - Examples of routine server maintenance using the HP RESTful API +- **docs** - Links to documents discussing the Redfish Specification +- **python-redfish** - The python Redfish library ## Requirements -To use the enclosed examples, you will need [Python 2.7](https://www.python.org/downloads/), and a ProLiant server running iLO 4 with network access to the iLO network port. Note that Python 2.7.9 enforces greater SSL verification requiring server certificates be installed. Parameters to relax the requirements are available in the sample scripts, but these configurations are discouraged due to security concerns. +To use the enclosed examples, you will need [Python 2.7](https://www.python.org/downloads/). Note that Python 2.7.9 enforces greater SSL verification requiring server certificates be installed. Parameters to relax the requirements are available in the library, but these configurations are discouraged due to security concerns. ## Shortcuts -- **repo webpage** - Shortened URL (http://git.io/hbp5)
-- **repo zip archive** - Shortened URL (http://git.io/hbj9)
-- **repo tar archive** - Shortened URL (http://git.io/hbhp)
+- **repo webpage** - Shortened URL (http://git.io/hbp5)
+- **repo zip archive** - Shortened URL (http://git.io/hbj9)
+- **repo tar archive** - Shortened URL (http://git.io/hbhp)
diff --git a/docs/Managing_HP_Servers_Using_RESTful_API.md b/docs/Managing_HP_Servers_Using_RESTful_API.md deleted file mode 100644 index 8e481d3..0000000 --- a/docs/Managing_HP_Servers_Using_RESTful_API.md +++ /dev/null @@ -1,2 +0,0 @@ -# Managing HP Servers Using the HP RESTful API for iLO -The overall protocol documentation can be found [here](http://h20564.www2.hp.com/hpsc/doc/public/display?docId=c04423967 "Managing HP Servers Using the HP RESTful API for iLO"). \ No newline at end of file diff --git a/docs/Redfish_API_Data_Model.md b/docs/Redfish_API_Data_Model.md new file mode 100644 index 0000000..e414e60 --- /dev/null +++ b/docs/Redfish_API_Data_Model.md @@ -0,0 +1,2 @@ +# Redfish: Data Model and Schema +The data model documentation can be found [here](http://www.redfishspecification.org/redfish-data-model-and-schema/ "Redfish: Data Model and Schema"). \ No newline at end of file diff --git a/docs/Redfish_Specification_Documentation.md b/docs/Redfish_Specification_Documentation.md new file mode 100644 index 0000000..60e24be --- /dev/null +++ b/docs/Redfish_Specification_Documentation.md @@ -0,0 +1,2 @@ +# Redfish Specification +The overall protocol documentation can be found [here](http://www.redfishspecification.org/ "Redfish Specification"). \ No newline at end of file diff --git a/docs/iLO_4_REST_API_Data_Model.md b/docs/iLO_4_REST_API_Data_Model.md deleted file mode 100644 index ba81522..0000000 --- a/docs/iLO_4_REST_API_Data_Model.md +++ /dev/null @@ -1,2 +0,0 @@ -# iLO 4 REST API Data Model -The data model documentation can be found [here](http://h20564.www2.hp.com/hpsc/doc/public/display?docId=c04423960 "HP RESTful API Data Model Reference for iLO 4"). \ No newline at end of file