- Replaced AuthZForce with AuthzForce

- Updated doc for release 8.0.x
authzforce · Jan 16, 2018 · 3ee606e · 3ee606e
1 parent d41cd7b
commit 3ee606e
Show file tree

Hide file tree

Showing 16 changed files with 389 additions and 338 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,11 @@
 # FIWARE-specific documentation and Docker distribution 
 This project is part of [FIWARE](https://www.fiware.org). More info on the [FIWARE catalogue](http://catalogue.fiware.org/enablers/authorization-pdp-authzforce).
 
-This project provides the source of various FIWARE-specific documents and packaging related to AuthZForce Server. AuthZForce Server is FIWARE Authorization PDP GEri (Generic Enabler Reference Implementation):
-- Technical specifications of the FIWARE Authorization PDP Generic Enabler (GE)'s API that AuthZForce implements in various forms:
+This project provides the source of various FIWARE-specific documents and packaging related to AuthzForce Server. AuthzForce Server is FIWARE Authorization PDP GEri (Generic Enabler Reference Implementation):
+- Technical specifications of the FIWARE Authorization PDP Generic Enabler (GE)'s API that AuthzForce implements in various forms:
   - WADL and XML schemas (the reference);
   - Apiary blueprint (the HTML output is available in [Apiary style](http://docs.authorizationpdp.apiary.io) and [FIWARE style](http://authzforce.github.io/fiware/) ).
-- The source of the GEri's documentation: Installation and Administration guide, User and Programmer Guide, etc. The generated documentation is available for each AuthZForce Server release as standalone HTML/PDF from the [Server release page](https://github.com/authzforce/server/releases), or online on [readthedocs.org](http://readthedocs.org/projects/authzforce-ce-fiware/versions/);
+- The source of the GEri's documentation: Installation and Administration guide, User and Programmer Guide, etc. The generated documentation is available for each AuthzForce Server release as standalone HTML/PDF from the [Server release page](https://github.com/authzforce/server/releases), or online on [readthedocs.org](http://readthedocs.org/projects/authzforce-ce-fiware/versions/);
 - The source of the GEri's Docker image published in FIWARE Docker hub.
 
 The actual source code of the GEri is in [server component's repository](https://github.com/authzforce/server).

diff --git a/apiary.apib b/apiary.apib
@@ -20,7 +20,7 @@ This specification defines a RESTful API of an Authorization Policy Decision Poi
 
 This APIARY blueprint gives a user-friendly description of the API. 
 However, the official API reference is available in a WADL (Web Application Description Language) 
-and XML schema files on the [Github repository of AuthZForce REST API model project](https://github.com/authzforce/rest-api-model/tree/release-5.2.0/src/main/resources). 
+and XML schema files on the [Github repository of AuthzForce REST API model project](https://github.com/authzforce/rest-api-model/tree/release-5.2.0/src/main/resources). 
 From this WADL (and associated XSD files), you can generate code automatically for various languages, e.g. Apache CXF's WADL2Java plugin for Java.
 
 ## Editors

diff --git a/authorization-pdp-ge/authorization-pdp.apib b/authorization-pdp-ge/authorization-pdp.apib
@@ -41,7 +41,7 @@ The FIWARE Authorization PDP API specification defines a RESTful API of an Autho
 
 This APIARY blueprint gives a user-friendly description of the API. 
 However, the official API reference is available in a WADL (Web Application Description Language) 
-and XML schema files on the [Github repository of AuthZForce REST API model project](https://github.com/authzforce/rest-api-model/tree/release-5.2.0/src/main/resources). 
+and XML schema files on the [Github repository of AuthzForce REST API model project](https://github.com/authzforce/rest-api-model/tree/release-5.2.0/src/main/resources). 
 From this WADL (and associated XSD files), you can generate code automatically for various languages, e.g. Apache CXF's WADL2Java plugin for Java.
 
 ## Conformance

diff --git a/doc/Features.md b/doc/Features.md
@@ -466,4 +466,4 @@ AuthzForce provides experimental support for [XACML 3.0 Additional Combining Alg
 
 ## High availability and load-balancing
 
-* Integration with file synchronization tools (e.g. [csync2](http://oss.linbit.com/csync2/)) or distributed filesystems (e.g. NFS and CIFS) to build clusters of AuthZForce Servers.
+* Integration with file synchronization tools (e.g. [csync2](http://oss.linbit.com/csync2/)) or distributed filesystems (e.g. NFS and CIFS) to build clusters of AuthzForce Servers.
diff --git a/doc/Features.rst b/doc/Features.rst
diff --git a/doc/InstallationAndAdministrationGuide.rst b/doc/InstallationAndAdministrationGuide.rst
diff --git a/doc/Introduction.rst b/doc/Introduction.rst
@@ -2,6 +2,6 @@
 Introduction
 ============
 
-AuthZForce is the reference implementation of the Authorization PDP Generic Enabler (formerly called Access Control GE). Indeed, as mandated by the GE specification, this implementation provides an API to get authorization decisions based on authorization policies, and authorization requests from PEPs. The API follows the REST architecture style, and complies with XACML v3.0. XACML (eXtensible Access Control Markup Language) is a OASIS standard for authorization policy format and evaluation logic, as well as for the authorization decision request/response format. The PDP (Policy Decision Point) and the PEP (Policy Enforcement Point) terms are defined in the XACML standard. This GEri plays the role of a PDP.
+AuthzForce is the reference implementation of the Authorization PDP Generic Enabler (formerly called Access Control GE). Indeed, as mandated by the GE specification, this implementation provides an API to get authorization decisions based on authorization policies, and authorization requests from PEPs. The API follows the REST architecture style, and complies with XACML v3.0. XACML (eXtensible Access Control Markup Language) is a OASIS standard for authorization policy format and evaluation logic, as well as for the authorization decision request/response format. The PDP (Policy Decision Point) and the PEP (Policy Enforcement Point) terms are defined in the XACML standard. This GEri plays the role of a PDP.
 
 To fulfill the XACML architecture, you may need a PEP (Policy Enforcement Point) to protect your application, which is not provided here. For REST APIs, we can use the PEP Proxy (Wilma) available in the FIWARE `catalogue <http://catalogue.fiware.org/enablers/pep-proxy-wilma>`_.
diff --git a/doc/Makefile b/doc/Makefile
@@ -87,9 +87,9 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/AuthZForce.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/AuthzForce.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/AuthZForce.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/AuthzForce.qhc"
 
 applehelp:
 	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@@ -104,8 +104,8 @@ devhelp:
 	@echo
 	@echo "Build finished."
 	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/AuthZForce"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/AuthZForce"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/AuthzForce"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/AuthzForce"
 	@echo "# devhelp"
 
 epub:

diff --git a/doc/ReleaseNotes.rst b/doc/ReleaseNotes.rst
@@ -2,4 +2,4 @@
 Release Notes
 =============
 
-The release notes are available on our `GitHub release page <https://github.com/authzforce/server/releases/tag/release-5.4.1>`_.
+The release notes are available on our `GitHub release page <https://github.com/authzforce/server/releases/>`_.