fixed hard-coded link issue, cleaned up wording, and added build script

This commit is contained in:
Jen Malloy 2016-12-01 15:01:51 -05:00
parent 1ffd8c9080
commit 4d87776b9e
3 changed files with 77 additions and 8 deletions

View file

@ -12,7 +12,7 @@
"title": "Securing Applications and Services Guide", "title": "Securing Applications and Services Guide",
"project": { "project": {
"name": "Red Hat Single Sign-On", "name": "Red Hat Single Sign-On",
"version": "7.0.0", "version": "7.1.0",
"versionMvn": "1.9.8.Final-redhat-1" "versionMvn": "1.9.8.Final-redhat-1"
}, },
"community": false, "community": false,
@ -20,7 +20,7 @@
"images": "rhsso-images", "images": "rhsso-images",
"adminguide": { "adminguide": {
"name": "Server Administration Guide", "name": "Server Administration Guide",
"link": "https://access.redhat.com/documentation/en/red-hat-single-sign-on/7.0/server-administration-guide/" "link": "https://access.redhat.com/documentation/en/red-hat-single-sign-on/7.1-Beta/server-administration-guide/"
} }
} }
} }

69
buildGuide.sh Executable file
View file

@ -0,0 +1,69 @@
# Build the guide
# Find the directory name and full path
CURRENT_GUIDE=${PWD##*/}
CURRENT_DIRECTORY=$(pwd)
usage(){
cat <<EOM
USAGE: $0 [OPTION]
DESCRIPTION: Build the documentation in this directory.
OPTIONS:
-h Print help.
EOM
}
while getopts "ht:" c
do
case "$c" in
h) usage
exit 1;;
\?) echo "Unknown option: -$OPTARG." >&2
usage
exit 1;;
esac
done
if [ ! -d target ]; then
echo "You must run 'python gitlab-conversion.py' to convert the content before you run this script."
exit
fi
# Remove the html and build directories and then recreate the html/images/ directory
if [ -d target/html ]; then
- rm -r target/html/
fi
if [ -d target/html ]; then
rm -r target/html/
fi
mkdir -p html
cp -r target/images/ target/html/
echo ""
echo "********************************************"
echo " Building $CURRENT_GUIDE "
echo "********************************************"
echo ""
echo "Building an asciidoctor version of the guide"
asciidoctor -t -dbook -a toc -o target/html/$CURRENT_GUIDE.html target/master.adoc
echo ""
echo "Building a ccutil version of the guide"
ccutil compile --lang en_US --format html-single --main-file target/master.adoc
cd ..
echo "View the asciidoctor build here: " file://$CURRENT_DIRECTORY/target/html/$CURRENT_GUIDE.html
if [ -d $CURRENT_DIRECTORY/build/tmp/en-US/html-single/ ]; then
echo "View the ccutil build here: " file://$CURRENT_DIRECTORY/build/tmp/en-US/html-single/index.html
exit 0
else
echo -e "${RED}Build using ccutil failed!"
echo -e "${BLACK}See the log above for details."
exit 1
fi

View file

@ -2,11 +2,11 @@
==== Parameters Forwarding ==== Parameters Forwarding
The {{book.project.name}} initial authorization endpoint request has support for various parameters. Most of the parameters are described in The {{book.project.name}} initial authorization endpoint request has support for various parameters. Most of the parameters are described in
http://openid.net/specs/openid-connect-core-1_0.html#AuthorizationEndpoint[OIDC specification] . Some parameters are added automatically by adapter based http://openid.net/specs/openid-connect-core-1_0.html#AuthorizationEndpoint[OIDC specification]. Some parameters are added automatically by the adapter based
on the adapter configuration. However there are also few parameters, which can be added on per-invocation basis. When you open the secured application URI, on the adapter configuration. However, there are also a few parameters that can be added on a per-invocation basis. When you open the secured application URI,
the particular parameter will be forwarded to the {{book.project.name}} authorization endpoint. the particular parameter will be forwarded to the {{book.project.name}} authorization endpoint.
For example, if you request offline token, then you can open the secured application URI with the `scope` parameter like: For example, if you request an offline token, then you can open the secured application URI with the `scope` parameter like:
[source] [source]
---- ----
@ -15,7 +15,7 @@ http://myappserver/mysecuredapp?scope=offline_access
and the parameter `scope=offline_access` will be automatically forwarded to the {{book.project.name}} authorization endpoint. and the parameter `scope=offline_access` will be automatically forwarded to the {{book.project.name}} authorization endpoint.
The supported parameters are actually: The supported parameters are:
* scope * scope
@ -28,5 +28,5 @@ The supported parameters are actually:
* kc_idp_hint * kc_idp_hint
Most of the parameters are described in the http://openid.net/specs/openid-connect-core-1_0.html#AuthorizationEndpoint[OIDC specification]. Most of the parameters are described in the http://openid.net/specs/openid-connect-core-1_0.html#AuthorizationEndpoint[OIDC specification].
The only exception is parameter `kc_idp_hint`, which is specific to {{book.project.name}} and contains the name of Identity provider to automatically use. The only exception is parameter `kc_idp_hint`, which is specific to {{book.project.name}} and contains the name of the identity provider to automatically use.
More info in {{book.adminguide.link}}[{{book.adminguide.name}}] in `Identity Brokering` section. For more information see the `Identity Brokering` section in {{book.adminguide.link}}[{{book.adminguide.name}}].