You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@syncope.apache.org by co...@apache.org on 2015/12/03 18:15:27 UTC
syncope git commit: Documentation updates
Repository: syncope
Updated Branches:
refs/heads/master 706cd3671 -> b4f893904
Documentation updates
Project: http://git-wip-us.apache.org/repos/asf/syncope/repo
Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/b4f89390
Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/b4f89390
Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/b4f89390
Branch: refs/heads/master
Commit: b4f8939043b02bcea607cbdaaf269f2db22bb9cc
Parents: 706cd36
Author: Colm O hEigeartaigh <co...@apache.org>
Authored: Thu Dec 3 17:14:41 2015 +0000
Committer: Colm O hEigeartaigh <co...@apache.org>
Committed: Thu Dec 3 17:15:20 2015 +0000
----------------------------------------------------------------------
.../apache/syncope/client/cli/ArgsManager.java | 2 +-
.../apache/syncope/client/cli/SyncopeAdm.java | 2 +-
.../commands/domain/DomainResultManager.java | 2 +-
.../commands/install/InstallResultManager.java | 8 +--
.../commands/schema/SchemaResultManager.java | 2 +-
.../cli/commands/task/TaskListRunningJobs.java | 2 +-
.../client/cli/commands/user/UserList.java | 2 +-
src/main/asciidoc/cli/configuration.adoc | 21 ++++----
src/main/asciidoc/cli/connector.adoc | 26 ++++-----
src/main/asciidoc/cli/domain.adoc | 8 +--
src/main/asciidoc/cli/entitlement.adoc | 14 ++---
src/main/asciidoc/cli/group.adoc | 16 +++---
src/main/asciidoc/cli/info.adoc | 4 +-
src/main/asciidoc/cli/installation.adoc | 34 ++++++------
src/main/asciidoc/cli/introduction.adoc | 13 +++--
src/main/asciidoc/cli/logger.adoc | 20 +++----
src/main/asciidoc/cli/notification.adoc | 8 +--
src/main/asciidoc/cli/policy.adoc | 16 +++---
src/main/asciidoc/cli/question.adoc | 12 ++---
src/main/asciidoc/cli/realm.adoc | 10 ++--
src/main/asciidoc/cli/report.adoc | 30 +++++------
src/main/asciidoc/cli/resource.adoc | 18 +++----
src/main/asciidoc/cli/role.adoc | 19 ++++---
src/main/asciidoc/cli/schema.adoc | 28 +++++-----
src/main/asciidoc/cli/task.adoc | 26 ++++-----
src/main/asciidoc/cli/user.adoc | 56 ++++++++++----------
src/main/asciidoc/introduction.adoc | 8 +--
src/main/asciidoc/obtain.adoc | 4 +-
28 files changed, 203 insertions(+), 208 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/client/cli/src/main/java/org/apache/syncope/client/cli/ArgsManager.java
----------------------------------------------------------------------
diff --git a/client/cli/src/main/java/org/apache/syncope/client/cli/ArgsManager.java b/client/cli/src/main/java/org/apache/syncope/client/cli/ArgsManager.java
index 3ec222a..06dd7f4 100644
--- a/client/cli/src/main/java/org/apache/syncope/client/cli/ArgsManager.java
+++ b/client/cli/src/main/java/org/apache/syncope/client/cli/ArgsManager.java
@@ -30,7 +30,7 @@ public final class ArgsManager {
final File configFile = new File(InstallConfigFileTemplate.configurationFilePath());
if (!configFile.exists()) {
throw new IllegalArgumentException(
- "It seems you need to setup the CLI client before. Run install --setup.");
+ "It seems you need to first setup the CLI client. Run install --setup.");
}
}
}
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/client/cli/src/main/java/org/apache/syncope/client/cli/SyncopeAdm.java
----------------------------------------------------------------------
diff --git a/client/cli/src/main/java/org/apache/syncope/client/cli/SyncopeAdm.java b/client/cli/src/main/java/org/apache/syncope/client/cli/SyncopeAdm.java
index 17abce8..2ececa1 100644
--- a/client/cli/src/main/java/org/apache/syncope/client/cli/SyncopeAdm.java
+++ b/client/cli/src/main/java/org/apache/syncope/client/cli/SyncopeAdm.java
@@ -46,7 +46,7 @@ public final class SyncopeAdm {
}
System.out.println("");
- System.out.println("You are runnig: " + input.printCommandFields());
+ System.out.println("You are running: " + input.printCommandFields());
command.execute(input);
} catch (final IllegalAccessException | InstantiationException e) {
System.out.println(helpMessage());
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/client/cli/src/main/java/org/apache/syncope/client/cli/commands/domain/DomainResultManager.java
----------------------------------------------------------------------
diff --git a/client/cli/src/main/java/org/apache/syncope/client/cli/commands/domain/DomainResultManager.java b/client/cli/src/main/java/org/apache/syncope/client/cli/commands/domain/DomainResultManager.java
index bed998e..5f15dfe 100644
--- a/client/cli/src/main/java/org/apache/syncope/client/cli/commands/domain/DomainResultManager.java
+++ b/client/cli/src/main/java/org/apache/syncope/client/cli/commands/domain/DomainResultManager.java
@@ -34,7 +34,7 @@ public class DomainResultManager extends CommonsResultManager {
public void printDomain(final DomainTO domainTO) {
System.out.println(" > DOIMAIN NAME: " + domainTO.getKey());
- System.out.println(" chiper algorithm: " + domainTO.getAdminCipherAlgorithm());
+ System.out.println(" cipher algorithm: " + domainTO.getAdminCipherAlgorithm());
System.out.println("");
}
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/client/cli/src/main/java/org/apache/syncope/client/cli/commands/install/InstallResultManager.java
----------------------------------------------------------------------
diff --git a/client/cli/src/main/java/org/apache/syncope/client/cli/commands/install/InstallResultManager.java b/client/cli/src/main/java/org/apache/syncope/client/cli/commands/install/InstallResultManager.java
index 32b6cf2..ad854f1 100644
--- a/client/cli/src/main/java/org/apache/syncope/client/cli/commands/install/InstallResultManager.java
+++ b/client/cli/src/main/java/org/apache/syncope/client/cli/commands/install/InstallResultManager.java
@@ -57,7 +57,7 @@ public class InstallResultManager extends CommonsResultManager {
System.out.println("###############################################");
System.out.println("# #");
System.out.println("# Provided unknown host! #");
- System.out.println("# START AGAIN the installation! #");
+ System.out.println("# START the installation AGAIN! #");
System.out.println("# #");
System.out.println("###############################################");
System.out.println("");
@@ -69,7 +69,7 @@ public class InstallResultManager extends CommonsResultManager {
System.out.println("# #");
System.out.println("# Provided address is unreachable! #");
System.out.println("# Check it and if it is wrong #");
- System.out.println("# START AGAIN the installation! #");
+ System.out.println("# START the installation AGAIN! #");
System.out.println("# #");
System.out.println("###############################################");
System.out.println("");
@@ -82,7 +82,7 @@ public class InstallResultManager extends CommonsResultManager {
System.out.println("###############################################");
System.out.println("# #");
System.out.println("# Username or password provided are wrong #");
- System.out.println("# START AGAIN the installation! #");
+ System.out.println("# START the installation AGAIN! #");
System.out.println("# #");
System.out.println("###############################################");
System.out.println("");
@@ -91,7 +91,7 @@ public class InstallResultManager extends CommonsResultManager {
System.out.println("###############################################");
System.out.println("# #");
System.out.println("# Something wrong #");
- System.out.println("# START AGAIN the installation! #");
+ System.out.println("# START the installation AGAIN! #");
System.out.println("# #");
System.out.println("###############################################");
System.out.println("");
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/client/cli/src/main/java/org/apache/syncope/client/cli/commands/schema/SchemaResultManager.java
----------------------------------------------------------------------
diff --git a/client/cli/src/main/java/org/apache/syncope/client/cli/commands/schema/SchemaResultManager.java b/client/cli/src/main/java/org/apache/syncope/client/cli/commands/schema/SchemaResultManager.java
index 5273cc9..b90c381 100644
--- a/client/cli/src/main/java/org/apache/syncope/client/cli/commands/schema/SchemaResultManager.java
+++ b/client/cli/src/main/java/org/apache/syncope/client/cli/commands/schema/SchemaResultManager.java
@@ -62,7 +62,7 @@ public class SchemaResultManager extends CommonsResultManager {
System.out.println(" mandatory condition: " + schemaTO.getMandatoryCondition());
System.out.println(" mime type: " + schemaTO.getMimeType());
System.out.println(" validator class: " + schemaTO.getValidatorClass());
- System.out.println(" chiper algorithm: " + (schemaTO.getCipherAlgorithm() == null
+ System.out.println(" cipher algorithm: " + (schemaTO.getCipherAlgorithm() == null
? "" : schemaTO.getCipherAlgorithm().getAlgorithm()));
System.out.println("");
}
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/client/cli/src/main/java/org/apache/syncope/client/cli/commands/task/TaskListRunningJobs.java
----------------------------------------------------------------------
diff --git a/client/cli/src/main/java/org/apache/syncope/client/cli/commands/task/TaskListRunningJobs.java b/client/cli/src/main/java/org/apache/syncope/client/cli/commands/task/TaskListRunningJobs.java
index dfdcaf2..9b3e980 100644
--- a/client/cli/src/main/java/org/apache/syncope/client/cli/commands/task/TaskListRunningJobs.java
+++ b/client/cli/src/main/java/org/apache/syncope/client/cli/commands/task/TaskListRunningJobs.java
@@ -42,7 +42,7 @@ public class TaskListRunningJobs extends AbstractTaskCommand {
try {
final List<TaskExecTO> taskExecTOs = taskSyncopeOperations.listRunningJobs();
if (taskExecTOs.isEmpty()) {
- taskResultManager.genericMessage("There is NOT running jobs available");
+ taskResultManager.genericMessage("There are NO running jobs available");
} else {
taskResultManager.printTaskExecTO(taskExecTOs);
}
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/client/cli/src/main/java/org/apache/syncope/client/cli/commands/user/UserList.java
----------------------------------------------------------------------
diff --git a/client/cli/src/main/java/org/apache/syncope/client/cli/commands/user/UserList.java b/client/cli/src/main/java/org/apache/syncope/client/cli/commands/user/UserList.java
index 881dc96..2b2f7b1 100644
--- a/client/cli/src/main/java/org/apache/syncope/client/cli/commands/user/UserList.java
+++ b/client/cli/src/main/java/org/apache/syncope/client/cli/commands/user/UserList.java
@@ -44,7 +44,7 @@ public class UserList extends AbstractUserCommand {
try {
final Scanner scanIn = new Scanner(System.in);
System.out.println(
- "\nThis operation might produce very heavy output. Do you want to continue? [yes/no]");
+ "\nThis operation might produce very large output. Do you want to continue? [yes/no]");
final String answer = scanIn.nextLine();
if ("yes".equalsIgnoreCase(answer)) {
final PagedResult<UserTO> uResult = userSyncopeOperations.list();
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/src/main/asciidoc/cli/configuration.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli/configuration.adoc b/src/main/asciidoc/cli/configuration.adoc
index 9bb0884..2ad6490 100644
--- a/src/main/asciidoc/cli/configuration.adoc
+++ b/src/main/asciidoc/cli/configuration.adoc
@@ -18,7 +18,7 @@
//
==== Configuration command
-The configuration command serves to retrieve the information about the Syncope configuration.
+The configuration command retrieves information about the Syncope configuration.
===== Help message
[source,bash]
@@ -49,7 +49,7 @@ $ ./syncopeadm.sh configuration --get
[source]
--
-You are runnig: configuration --get
+You are running: configuration --get
########################################################
# #
@@ -79,7 +79,7 @@ You are runnig: configuration --get
--
===== Read option
-The option to read the value of a specified configuration attributes.
+The option to read the value of specified configuration attributes.
[source]
--
@@ -89,7 +89,7 @@ $ ./syncopeadm.sh configuration --read {CONF-NAME} {CONF-NAME} [...]
[source]
--
-You are runnig: configuration --read passwordReset.allowed
+You are running: configuration --read passwordReset.allowed
#####################################
# #
@@ -108,7 +108,7 @@ You are runnig: configuration --read passwordReset.allowed
--
===== Update option
-The option to update a value of a specified configuration attributes.
+The option to update a value of specified configuration attributes.
[source]
--
@@ -118,7 +118,7 @@ $ ./syncopeadm.sh configuration --update {CONF-NAME}={CONF-VALUE} {CONF-NAME}={C
[source]
--
-You are runnig: configuration --update passwordReset.allowed=false
+You are running: configuration --update passwordReset.allowed=false
#####################################
# #
@@ -137,22 +137,21 @@ You are runnig: configuration --update passwordReset.allowed=false
--
===== Delete option
-The option to delete a specified configuration attributes.
+The option to delete specified configuration attributes.
[source]
--
$ ./syncopeadm.sh configuration --delete {CONF-NAME} {CONF-NAME} [...]
--
-The delete option, as can be imagined, tries to remove a specified roles.
-The output will be something like:
+The delete option, as can be imagined, tries to remove the specified configurations. The output will be something like:
[source]
--
- Configuration {CONF-NAME} successfully deleted
--
===== Export option
-The option to export the Syncope configuration under specified directory.
+The option to export the Syncope configuration to a specified directory.
[source]
--
@@ -169,4 +168,4 @@ $ ./syncopeadm.sh - Usage: configuration --export {WHERE-DIR}
<PASSWORDPOLICY ALLOWNULLPASSWORD="0" DESCRIPTION="sample password policy" HISTORYLENGTH="0" ID="8" TYPE="PASSWORD"/>
[...]
-----
\ No newline at end of file
+----
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/src/main/asciidoc/cli/connector.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli/connector.adoc b/src/main/asciidoc/cli/connector.adoc
index bf508a5..51b622d 100644
--- a/src/main/asciidoc/cli/connector.adoc
+++ b/src/main/asciidoc/cli/connector.adoc
@@ -18,7 +18,7 @@
//
==== Connector command
-The connector command serves to retrieve the information around the connector configuration in Apache Syncope.
+The connector command serves to retrieve information about the connector configuration in Apache Syncope.
===== Help message
[source,bash]
@@ -48,7 +48,7 @@ $ ./syncopeadm.sh connector --details
[source]
--
-You are runnig: connector --details
+You are running: connector --details
######################################
# #
@@ -98,7 +98,7 @@ $ ./syncopeadm.sh connector --list
[source]
--
-You are runnig: connector --list
+You are running: connector --list
> CONNECTOR ID: 108
bundle name: net.tirasa.connid.bundles.db.scriptedsql
@@ -149,7 +149,7 @@ You are runnig: connector --list
--
-The last snippet code shows a part of the screen output. Basically you can read the configuration about every connectors
+The last code snippet shows a part of the screen output. Basically you can read the configuration about every connector
configured in Syncope.
===== List bundles option
@@ -163,7 +163,7 @@ $ ./syncopeadm.sh connector --list-bundles
[source]
--
-You are runnig: connector --list-bundles
+You are running: connector --list-bundles
> BUNDLE NAME: net.tirasa.connid.bundles.soap
connector name: net.tirasa.connid.bundles.soap.WebServiceConnector
@@ -208,23 +208,23 @@ You are runnig: connector --list-bundles
--
-The most useful information are:
+The most useful information is:
location::
where the bundle is, it could be on the same server where Syncope is deployed or on a remote one linked by
connid protocol;
-version:
+version::
the bundle version;
===== List configuration properties option
-The option to read only the configuration of specified connectors.
+This option lists the configuration of specified connectors.
[source]
--
$ ./syncopeadm.sh connector --list-configuration-properties {CONNECTOR-ID} {CONNECTOR-ID} [...]
--
-The output is only the configuration of the connectors passed as input.
+The output is the configuration of the connectors passed as input.
===== Read option
The option to read all the information of specified connectors.
@@ -237,15 +237,15 @@ $ ./syncopeadm.sh connector --read {CONNECTOR-ID} {CONNECTOR-ID} [...]
Unlike the list option, the read one shows only the connectors passed as input.
===== Delete option
-The option to delete a specified connectors.
+The option to delete a specified connector.
[source]
--
$ ./syncopeadm.sh connector --delete {CONNECTOR-ID} {CONNECTOR-ID} [...]
--
-The delete option, as can be imagined, tries to remove a specified connectors. This operation works only if the
-connector isn't associated to a resource.
+The delete option, as can be imagined, tries to remove a specified connector. This operation works only if the
+connector isn't associated with a resource.
If the connector isn't associated to anything the output will be
[source]
--
@@ -256,4 +256,4 @@ otherwise the output will be something like:
[source]
--
- Error: AssociatedResources [ws-target-resource-nopropagation, ws-target-resource-nopropagation2]
---
\ No newline at end of file
+--
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/src/main/asciidoc/cli/domain.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli/domain.adoc b/src/main/asciidoc/cli/domain.adoc
index 3ff78d9..8d4db83 100644
--- a/src/main/asciidoc/cli/domain.adoc
+++ b/src/main/asciidoc/cli/domain.adoc
@@ -18,7 +18,7 @@
//
==== Domain command
-The domain command serves to retrieve the information about the configured domains.
+The domain command retrieves information about the configured domains.
===== Help message
[source,bash]
@@ -43,7 +43,7 @@ $ ./syncopeadm.sh domain --details
[source]
--
-You are runnig: domain --details
+You are running: domain --details
############################
# #
@@ -72,7 +72,7 @@ $ ./syncopeadm.sh domain --list
[source]
--
-You are runnig: domain --list
+You are running: domain --list
> DOIMAIN NAME: Two
chiper algorithm: SHA
@@ -92,4 +92,4 @@ The output will be something like:
[source]
--
- Domain {DOMAIN-NAME} successfully deleted
---
\ No newline at end of file
+--
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/src/main/asciidoc/cli/entitlement.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli/entitlement.adoc b/src/main/asciidoc/cli/entitlement.adoc
index c7bc30f..e9a615a 100644
--- a/src/main/asciidoc/cli/entitlement.adoc
+++ b/src/main/asciidoc/cli/entitlement.adoc
@@ -18,7 +18,7 @@
//
==== Entitlement command
-The entitlement command serves to retrieve the information about the entitlments.
+The entitlement command retrieves information about the entitlments.
===== Help message
[source,bash]
@@ -48,7 +48,7 @@ $ ./syncopeadm.sh entitlement --list
[source]
--
-You are runnig: entitlement --list
+You are running: entitlement --list
- CONNECTOR_READ
- NOTIFICATION_DELETE
@@ -70,7 +70,7 @@ $ ./syncopeadm.sh entitlement --list
[source]
--
-You are runnig: entitlement --list-role PRINTER_DELETE
+You are running: entitlement --list-role PRINTER_DELETE
> ROLE ID: Search for realm evenTwo
REALMS:
@@ -100,7 +100,7 @@ $ ./syncopeadm.sh entitlement --read-by-username {USERNAME}
--
[source]
--
-You are runnig: entitlement --read-by-username rossini
+You are running: entitlement --read-by-username rossini
- GROUP_READ
- SCHEMA_READ
@@ -116,7 +116,7 @@ $ ./syncopeadm.sh entitlement --read-by-userid {USER-ID}
--
[source]
--
-You are runnig: entitlement --read-by-userid 5
+You are running: entitlement --read-by-userid 5
- USER_READ
- USER_SEARCH
@@ -132,9 +132,9 @@ $ ./syncopeadm.sh entitlement --search-by-role {ROLE-ID}
[source]
--
-You are runnig: entitlement --search-by-role Other
+You are running: entitlement --search-by-role Other
- SCHEMA_READ
- GROUP_READ
- WORKFLOW_FORM_CLAIM
---
\ No newline at end of file
+--
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/src/main/asciidoc/cli/group.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli/group.adoc b/src/main/asciidoc/cli/group.adoc
index c9a41a2..f71ccb4 100644
--- a/src/main/asciidoc/cli/group.adoc
+++ b/src/main/asciidoc/cli/group.adoc
@@ -18,7 +18,7 @@
//
==== Group command
-The group command serves to retrieve the information about the configured groups.
+The group command retrieves information about the configured groups.
===== Help message
[source,bash]
@@ -39,7 +39,7 @@ Usage: group [options]
----
===== Details option
-This option shows a table with group amount and some information.
+This option shows a table with the amount of available groups and some additional information.
[source]
--
@@ -49,7 +49,7 @@ $ ./syncopeadm.sh group --details
[source]
--
-You are runnig: group --details
+You are running: group --details
##################################
# #
@@ -82,7 +82,7 @@ $ ./syncopeadm.sh group --list
[source]
--
-You are runnig: group --list
+You are running: group --list
> GROUP ID: 1
name: root
@@ -126,7 +126,7 @@ $ ./syncopeadm.sh group --read {GROUP-ID} {GROUP-ID} [...]
[source]
--
-You are runnig: group --read 15
+You are running: group --read 15
> GROUP ID: 15
name: additional
@@ -162,7 +162,7 @@ $ ./syncopeadm.sh group --read-attr-by-schema-type {GROUP-ID} {SCHEMA-TYPE}
[source]
--
-You are runnig: group --read-attr-by-schema-type 15 DERIVED
+You are running: group --read-attr-by-schema-type 15 DERIVED
- displayProperty: [: ] - is readonly
- rderToBePropagated: [-] - is readonly
@@ -185,7 +185,7 @@ $ ./syncopeadm.sh group --read-attr-by-schema {GROUP-ID} {SCHEMA-TYPE} {SCHEMA-
[source]
--
-You are runnig: group --read-attr-by-schema 12 PLAIN title
+You are running: group --read-attr-by-schema 12 PLAIN title
- title: [r12]
--
@@ -203,4 +203,4 @@ The output will be something like:
[source]
--
- Group {GROUP-ID} successfully deleted
---
\ No newline at end of file
+--
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/src/main/asciidoc/cli/info.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli/info.adoc b/src/main/asciidoc/cli/info.adoc
index 2186862..9806110 100644
--- a/src/main/asciidoc/cli/info.adoc
+++ b/src/main/asciidoc/cli/info.adoc
@@ -18,7 +18,7 @@
//
==== Info command
-The info command serves to show some information about the Syncope installation.
+The info command shows some information about the Syncope installation.
===== Help message
[source,bash]
@@ -49,4 +49,4 @@ Usage: info [options]
--password-generator
--vir-attr-cache
--help
-----
\ No newline at end of file
+----
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/src/main/asciidoc/cli/installation.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli/installation.adoc b/src/main/asciidoc/cli/installation.adoc
index 1f93808..6d828fd 100644
--- a/src/main/asciidoc/cli/installation.adoc
+++ b/src/main/asciidoc/cli/installation.adoc
@@ -18,10 +18,10 @@
//
==== Installation command
-The installation process serves to create a file, called _cli.properties_, uses by the script to call the Apache Syncope
+The installation process creates a file, called _cli.properties_, used by the script to call the Apache Syncope
REST API services with the right credentials.
-The obtained file will be something like
+The properties file will contain content similar to:
* *syncope.rest.services*=http://localhost:9080/syncope/rest
* *syncope.admin.user*=admin
@@ -30,13 +30,13 @@ The obtained file will be something like
where the properties are:
syncope.rest.services::
- is the URL where the Apache Syncope REST API services listening;
+ the URL where the Apache Syncope REST API services are listening;
syncope.admin.user::
- is the user with the right permissions to call the Syncope APIs;
+ the user with the permission to call the Syncope APIs;
syncope.admin.password::
- is the user password;
+ the user password;
-as you can read, the user password is encrypted. This only to add a security level to avoid that another user could
+as can be seen, the user password is encrypted. This is only to avoid that another user could
read an admin password.
===== Help message
@@ -51,10 +51,10 @@ Usage: install [options]
===== Run the installation
After the zip file is unzipped you can start with CLI client using the syncopeadm file.
-If you tried to run a CLI command before installation process the script returns
+If you tried to run a CLI command before the installation process, the script returns
[source]
--
- - Error: It seems you need to setup the CLI client before. Run install --setup.
+ - Error: It seems you need to first setup the CLI client. Run install --setup.
--
So, as suggested, you have to run the install command to use the CLI:
@@ -67,7 +67,7 @@ A successful result will be:
[source,bash]
----
-You are runnig: install --setup
+You are running: install --setup
###############################################
# #
@@ -104,14 +104,14 @@ Syncope server hostname::
Syncope server port::
the port where the services are listening;
Syncope server rest context::
- the context wherewith the rest services are deployed (/syncope/rest is the default one);
+ the context where the rest services are deployed (/syncope/rest is the default);
Syncope admin user::
- the user with the right permissions to call the Syncope APIs;
+ the user with the permission to call the Syncope APIs;
Syncope admin password::
the user password.
===== Installation error
-The causes to get an error may be different, below some result samples.
+Various error messages are possible on installation. Here are some sample error messages:
* Syncope unreachable (or wrong address):
@@ -124,7 +124,7 @@ Provided address :http://localhost:9080/syncope/rest
# #
# Provided address is unreachable! #
# Check it and if it is wrong #
-# START AGAIN the installation! #
+# START the installation AGAIN! #
# #
###############################################
@@ -138,13 +138,13 @@ Provided address :http://localhost:9080/syncope/rest
###############################################
# #
# Username or password provided are wrong #
-# START AGAIN the installation! #
+# START the installation AGAIN! #
# #
###############################################
--
-As the message suggested you have to start again the installation when error occurred.
+As the message suggests you have to start the installation again when this error occurrs.
===== Debug installation
@@ -152,12 +152,12 @@ To work with the debug environment provided by Syncope we added a particular ins
It enough to run the script with the --setup-debug option
[source]
--
-$ ./syncopeadm.sh install --setup
+$ ./syncopeadm.sh install --setup-debug
--
[source,bash]
----
-You are runnig: install --setup-debug
+You are running: install --setup-debug
###############################################
# #
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/src/main/asciidoc/cli/introduction.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli/introduction.adoc b/src/main/asciidoc/cli/introduction.adoc
index e7bf329..76960bf 100644
--- a/src/main/asciidoc/cli/introduction.adoc
+++ b/src/main/asciidoc/cli/introduction.adoc
@@ -20,15 +20,14 @@
==== Introduction
A brief introduction about this document and the examples you will find reading it.
-Once you downloaded and uzipped the zip file containing the scripts, you will find a lib directory and the
-two script files, a .bat and a .sh one, called _syncopeadm_. According with your operating system you will use
-one of them.
+Once you have downloaded and unzipped the zip file containing the scripts, you will find a lib directory and
+two script files, a .bat and a .sh one, called _syncopeadm_. You will use one of these files, depending on your operating system.
[NOTE]
-Every examples of this document is executed on a linux machine with _debug environment_ up.
+Every example described in this document is executed on a linux machine with a _debug environment_.
[NOTE]
-As the Wikipedia page suggests a https://en.wikipedia.org/wiki/Command-line_interface[command line interface] (CLI)
-is a means of interacting with a computer program where the user (or client) issues commands to the program
+Wikipedia suggests that a https://en.wikipedia.org/wiki/Command-line_interface[command line interface] (CLI)
+is a means of interacting with a computer program, where the user (or client) issues commands to the program
in the form of successive lines of text (command lines). In our case the CLI tool is the way to call, more or less,
-every Syncope core commands through a shell.
\ No newline at end of file
+every Syncope core command through a shell.
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/src/main/asciidoc/cli/logger.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli/logger.adoc b/src/main/asciidoc/cli/logger.adoc
index 83b93c0..f03064f 100644
--- a/src/main/asciidoc/cli/logger.adoc
+++ b/src/main/asciidoc/cli/logger.adoc
@@ -18,7 +18,7 @@
//
==== Logger command
-The logger command serves to retrieve the information about the logger configuration in Apache Syncope.
+The logger command retrieves information about the logger configuration in Apache Syncope.
===== Help message
[source,bash]
@@ -51,7 +51,7 @@ $ ./syncopeadm.sh logger --details
[source]
--
-You are runnig: logger --details
+You are running: logger --details
############################
# #
@@ -87,7 +87,7 @@ $ ./syncopeadm.sh logger --list
[source]
--
-You are runnig: logger --list
+You are running: logger --list
############################################################################
# #
@@ -128,7 +128,7 @@ The option to read all the information of specified loggers.
$ ./syncopeadm.sh logger --read {LOG-NAME} {LOG-NAME} [...]
--
-Unlike the list option, the read one shows a table with only the loggers passed as input.
+Unlike the list option, the read option shows a table with only the loggers passed as input.
===== Update option
The option to change the value of the logger passed as input.
@@ -141,7 +141,7 @@ $ ./syncopeadm.sh logger --update {LOG-NAME}={LOG-LEVEL} {LOG-NAME}={LOG-LEVEL}
[source]
--
-You are runnig: logger --update org.apache.camel=DEBUG
+You are running: logger --update org.apache.camel=DEBUG
####################################
# #
@@ -160,7 +160,7 @@ You are runnig: logger --update org.apache.camel=DEBUG
--
===== Update all option
-This option is especially helpful in production environment when every log is disable and you need to change them for a
+This option is especially helpful in production environment when every log is disabled and you need to change them for a
while in DEBUG mode.
[source]
@@ -171,7 +171,7 @@ $ ./syncopeadm.sh logger --update-all DEBUG
[source]
--
-You are runnig: logger --update-all DEBUG
+You are running: logger --update-all DEBUG
################################################################################
# #
@@ -214,7 +214,7 @@ $ ./syncopeadm.sh logger --create net.tirasa=ERROR
[source]
--
-You are runnig: logger --create net.tirasa=ERROR
+You are running: logger --create net.tirasa=ERROR
##############################
# #
@@ -243,8 +243,8 @@ $ ./syncopeadm.sh logger --delete {LOG-NAME} {LOG-NAME} [...]
[source]
--
-You are runnig: logger --delete org.apache.camel
+You are running: logger --delete org.apache.camel
- Logger org.apache.camel successfully deleted
---
\ No newline at end of file
+--
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/src/main/asciidoc/cli/notification.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli/notification.adoc b/src/main/asciidoc/cli/notification.adoc
index d25beb1..98ebe7d 100644
--- a/src/main/asciidoc/cli/notification.adoc
+++ b/src/main/asciidoc/cli/notification.adoc
@@ -18,7 +18,7 @@
//
==== Notification command
-The notification command serves to retrieve the information about the configured notification.
+The notification command retrieves information about the configured notifications.
===== Help message
[source,bash]
@@ -44,7 +44,7 @@ $ ./syncopeadm.sh notification --list
[source]
--
-You are runnig: notification --list
+You are running: notification --list
> NOTIFICATION ID: 1
events: [[CUSTOM]:[]:[]:[requestPasswordReset]:[SUCCESS]]
@@ -91,7 +91,7 @@ You are runnig: notification --list
--
===== Read option
-The option to read all the information of specified notification.
+The option to read all the information of the specified notifications.
[source]
--
@@ -113,4 +113,4 @@ The output will be something like:
[source]
--
- security notification {NOTIFICATION-ID} successfully deleted
---
\ No newline at end of file
+--
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/src/main/asciidoc/cli/policy.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli/policy.adoc b/src/main/asciidoc/cli/policy.adoc
index af51145..554c195 100644
--- a/src/main/asciidoc/cli/policy.adoc
+++ b/src/main/asciidoc/cli/policy.adoc
@@ -18,7 +18,7 @@
//
==== Policy command
-The policy command serves to retrieve the information about the policies for each type.
+The policy command retrieves information about the policies for each type.
===== Help message
[source,bash]
@@ -37,7 +37,7 @@ Usage: policy [options]
----
===== Details option
-This option shows a table with policies amount for each type.
+This option shows a table with the amount of policies for each type.
[source]
--
@@ -47,7 +47,7 @@ $ ./syncopeadm.sh policy --details
[source]
--
-You are runnig: policy --details
+You are running: policy --details
#################################
# #
@@ -81,7 +81,7 @@ $ ./syncopeadm.sh Usage: policy --list {POLICY-TYPE}
[source]
--
-You are runnig: policy --list SYNC
+You are running: policy --list SYNC
> KEY: 1
type: SYNC
@@ -116,17 +116,17 @@ You are runnig: policy --list SYNC
--
===== Read option
-The option to read all the information of specified policy.
+The option to read all the information of a specified policy.
[source]
--
$ ./syncopeadm.sh policy --read {POLICY-ID} {POLICY-ID} [...]
--
-Unlike the list option, the read one shows only the policy passed as input.
+Unlike the list option, the read option shows only the policy passed as input.
[source]
--
-You are runnig: policy --read 6
+You are running: policy --read 6
> KEY: 6
type: ACCOUNT
@@ -163,4 +163,4 @@ The output will be something like:
[source]
--
- Policy {POLICY-ID} successfully deleted
---
\ No newline at end of file
+--
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/src/main/asciidoc/cli/question.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli/question.adoc b/src/main/asciidoc/cli/question.adoc
index c9ef57b..ff04845 100644
--- a/src/main/asciidoc/cli/question.adoc
+++ b/src/main/asciidoc/cli/question.adoc
@@ -18,7 +18,7 @@
//
==== Question command
-The question command serves to retrieve the information about the user question to retrieve his password.
+The question command gets information about the user question to retrieve their password.
===== Help message
[source,bash]
@@ -44,7 +44,7 @@ $ ./syncopeadm.sh question --list
[source]
--
-You are runnig: question --list
+You are running: question --list
> SECURITY QUESTION ID: 1
content: What's your mother's maiden name?
@@ -59,19 +59,19 @@ The option to read all the information of specified questions.
$ ./syncopeadm.sh question --read {QUESTION-ID} {QUESTION-ID} [...]
--
-Unlike the list option, the read one shows only the questions passed as input.
+Unlike the list option, the read option shows only the questions passed as input.
===== Delete option
-The option to delete a specified questions.
+The option to delete a specified question.
[source]
--
$ ./syncopeadm.sh question --delete {QUESTION-ID} {QUESTION-ID} [...]
--
-The delete option, as can be imagined, tries to remove a specified questions.
+The delete option, as can be imagined, tries to remove a specified question.
The output will be something like:
[source]
--
- security question {QUESTION-ID} successfully deleted
---
\ No newline at end of file
+--
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/src/main/asciidoc/cli/realm.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli/realm.adoc b/src/main/asciidoc/cli/realm.adoc
index 2b6855b..82ad44b 100644
--- a/src/main/asciidoc/cli/realm.adoc
+++ b/src/main/asciidoc/cli/realm.adoc
@@ -18,7 +18,7 @@
//
==== Realm command
-The realm command serves to retrieve the information about the configured realm.
+The realm command retrieves information about the configured realm.
===== Help message
[source,bash]
@@ -31,7 +31,7 @@ Usage: realm [options]
----
===== Details option
-This option shows a table with realm amount.
+This option shows a table with the amount of the available realms.
[source]
--
@@ -41,7 +41,7 @@ $ ./syncopeadm.sh realm --details
[source]
--
-You are runnig: realm --details
+You are running: realm --details
############################
# #
@@ -70,7 +70,7 @@ $ ./syncopeadm.sh realm --list
[source]
--
-You are runnig: realm --list
+You are running: realm --list
> REALM ID: 1
name: /
@@ -108,4 +108,4 @@ You are runnig: realm --list
account policy id: 5
password policy id: 2
---
\ No newline at end of file
+--
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/src/main/asciidoc/cli/report.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli/report.adoc b/src/main/asciidoc/cli/report.adoc
index 2be0aec..694ddc2 100644
--- a/src/main/asciidoc/cli/report.adoc
+++ b/src/main/asciidoc/cli/report.adoc
@@ -18,7 +18,7 @@
//
==== Report command
-The report command serves to retrieve the information about the configured reports.
+The report command retrieves information about the configured reports.
===== Help message
[source,bash]
@@ -55,7 +55,7 @@ $ ./syncopeadm.sh report --details
[source]
--
-You are runnig: report --details
+You are running: report --details
##############################
# #
@@ -75,7 +75,7 @@ You are runnig: report --details
--
===== List all option
-Running the command with this option you will see the list of report configured.
+Running the command with this option you will see the list of configured reports.
[source]
--
@@ -83,7 +83,7 @@ $ ./syncopeadm.sh report --list
--
[source]
--
-You are runnig: report --list
+You are running: report --list
> REPORT ID: 1
name: test
@@ -108,7 +108,7 @@ You are runnig: report --list
--
===== List reports execution option
-Running the command with this option you will see the list of the report execution executed.
+Running the command with this option you will see the list of the report executions.
[source]
--
@@ -118,7 +118,7 @@ $ ./syncopeadm.sh report --list-jobs
[source]
--
-You are runnig: report --list-jobs
+You are running: report --list-jobs
REPORT EXEC ID: 0
status: Not Scheduled
@@ -130,7 +130,7 @@ You are runnig: report --list-jobs
--
===== Read option
-The option to read all the information of specified report.
+The option to read all the information of a specified report.
[source]
--
@@ -139,7 +139,7 @@ $ ./syncopeadm.sh report --read {REPORT-ID} {REPORT-ID} [...]
[source]
--
-You are runnig: report --read 1
+You are running: report --read 1
> REPORT ID: 1
name: test
@@ -164,7 +164,7 @@ You are runnig: report --read 1
--
===== Read report executions option
-The option to read all the information of specified report execution.
+The option to read all the information of a specified report execution.
[source]
--
@@ -173,7 +173,7 @@ $ ./syncopeadm.sh rreport --read-execution {EXECUTION-ID} {EXECUTION-ID} [...]
[source]
--
-You are runnig: report --read-execution 1
+You are running: report --read-execution 1
REPORT EXEC ID: 1
status: SUCCESS
@@ -221,7 +221,7 @@ $ ./syncopeadm.sh report --execute {REPORT-ID}
[source]
--
-You are runnig: report --execute 1
+You are running: report --execute 1
- Report 1executed.
@@ -229,7 +229,7 @@ You are runnig: report --execute 1
- Run --read 1 to see the results.
--
-As you can read, after the execution, if the result is positive, you have to read the report to know the execution
+After the execution, if the result is positive, you have to read the report to know the execution
results.
===== Export execution option
@@ -240,13 +240,13 @@ At the moment only the XML format is supported.
[source]
--
-$ ./syncopeadm.sh eport --export-execution-result {EXECUTION-ID} {EXECUTION-ID} [...] {FORMAT}
+$ ./syncopeadm.sh report --export-execution-result {EXECUTION-ID} {EXECUTION-ID} [...] {FORMAT}
Format: CSV / HTML / PDF / XML / RTF
--
[source]
--
-You are runnig: report --export-execution-result 101 XML
+You are running: report --export-execution-result 101 XML
- export_101.xml created.
---
\ No newline at end of file
+--
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/src/main/asciidoc/cli/resource.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli/resource.adoc b/src/main/asciidoc/cli/resource.adoc
index 10d31b4..e0c111c 100644
--- a/src/main/asciidoc/cli/resource.adoc
+++ b/src/main/asciidoc/cli/resource.adoc
@@ -18,7 +18,7 @@
//
==== Resource command
-The resource command serves to retrieve the information about the resources.
+The resource command retrieves information about the resources.
===== Help message
[source,bash]
@@ -35,7 +35,7 @@ Usage: resource [options]
----
===== Details option
-This option shows a table with resource amount.
+This option shows a table with amount of available resources.
[source]
--
@@ -45,7 +45,7 @@ $ ./syncopeadm.sh resource --details
[source]
--
-You are runnig: resource --details
+You are running: resource --details
#############################
# #
@@ -67,7 +67,7 @@ Total number::
number of resources;
===== List option
-Running the command with this option you will see the list of the resources.
+Running the command with this option you will see the list of resources.
[source]
--
@@ -77,7 +77,7 @@ $ ./syncopeadm.sh resource --list
[source]
--
-You are runnig: resource --list
+You are running: resource --list
> RESOURCE ID: ws-target-resource-1
connector dispaly name: ConnInstance100
@@ -183,14 +183,14 @@ You are runnig: resource --list
--
===== Read option
-The option to read all the information of specified resource.
+The option to read all the information of a specified resource.
[source]
--
$ ./syncopeadm.sh resource --read {RESOURCE-NAME} {RESOURCE-NAME} [...]
--
-Unlike the list option, the read one shows only the resources passed as input.
+Unlike the list option, the read option shows only the resources passed as input.
===== Delete option
The option to delete a specified resource.
@@ -200,9 +200,9 @@ The option to delete a specified resource.
$ ./syncopeadm.sh resource --delete {RESOURCE-NAME} {RESOURCE-NAME} [...]
--
-The delete option, as can be imagined, tries to remove a specified resources.
+The delete option, as can be imagined, tries to remove the specified resources.
The output will be something like:
[source]
--
- Resource {RESOURCE-NAME} successfully deleted
---
\ No newline at end of file
+--
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/src/main/asciidoc/cli/role.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli/role.adoc b/src/main/asciidoc/cli/role.adoc
index cc3f244..c36ea4e 100644
--- a/src/main/asciidoc/cli/role.adoc
+++ b/src/main/asciidoc/cli/role.adoc
@@ -18,7 +18,7 @@
//
==== Role command
-The role command serves to retrieve the information about the roles.
+The role command retrieves information about the roles.
===== Help message
[source,bash]
@@ -45,7 +45,7 @@ $ ./syncopeadm.sh role --details
[source]
--
-You are runnig: role --details
+You are running: role --details
####################################
# #
@@ -67,11 +67,10 @@ You are runnig: role --details
Total number::
number of created roles;
Without entitlements::
- number of roles without linked entitlments.
+ number of roles without linked entitlements.
===== List option
-Running the command with this option you will see the list of roles with the realm where are configured
-and their entitlments.
+Running the command with this option you will see the list of roles with the realm where they are configured and their entitlments.
[source]
--
@@ -81,7 +80,7 @@ $ ./syncopeadm.sh role --list
[source]
--
-You are runnig: role --list
+You are running: role --list
> ROLE ID: User reviewer
REALMS:
@@ -131,19 +130,19 @@ The option to read all the information of specified roles.
$ ./syncopeadm.sh role --read {ROLE-NAME} {ROLE-NAME} [...]
--
-Unlike the list option, the read one shows only the roles passed as input.
+Unlike the list option, the read option shows only the roles passed as input.
===== Delete option
-The option to delete a specified roles.
+The option to delete specified roles.
[source]
--
$ ./syncopeadm.sh role --delete {ROLE-NAME} {ROLE-NAME} [...]
--
-The delete option, as can be imagined, tries to remove a specified roles.
+The delete option, as can be imagined, tries to remove specified roles.
The output will be something like:
[source]
--
- role {ROLE-NAME} successfully deleted
---
\ No newline at end of file
+--
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/src/main/asciidoc/cli/schema.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli/schema.adoc b/src/main/asciidoc/cli/schema.adoc
index 0e88f07..41f7a45 100644
--- a/src/main/asciidoc/cli/schema.adoc
+++ b/src/main/asciidoc/cli/schema.adoc
@@ -18,7 +18,7 @@
//
==== Schema command
-The schema command serves to retrieve the information about every schema categories.
+The schema command serves retrieves information about the schema categories.
===== Help message
[source,bash]
@@ -48,7 +48,7 @@ $ ./syncopeadm.sh schema --details
[source]
--
-You are runnig: schema --details
+You are running: schema --details
##############################
# #
@@ -88,7 +88,7 @@ $ ./syncopeadm.sh schema --list-plain
[source]
--
-You are runnig: schema --list-plain
+You are running: schema --list-plain
################################################################
# #
@@ -151,7 +151,7 @@ You are runnig: schema --list-plain
===== List derived option
Running the command with this option you will see the list of the derived schemas available in Syncope with
-their expression.
+their expressions.
[source]
--
@@ -161,7 +161,7 @@ $ ./syncopeadm.sh schema --list-derived
[source]
--
-You are runnig: schema --list-derived
+You are running: schema --list-derived
#######################################################################################
# #
@@ -199,7 +199,7 @@ $ ./syncopeadm.sh schema --list-virtual
[source]
--
-You are runnig: schema --list-virtual
+You are running: schema --list-virtual
##################################
# #
@@ -220,7 +220,7 @@ You are runnig: schema --list-virtual
--
===== Read option
-The option to read all the information of specified schema.
+The option to read all the information of a specified schema.
[source]
--
@@ -228,13 +228,13 @@ $ ./syncopeadm.sh schema --read {SCHEMA-TYPE} {SCHEMA-KEY}
Schema type: PLAIN / DERIVED / VIRTUAL
--
-Unlike the list option, the read one shows the schema passed as input and, in case of PLAIN category, the full
-attributes of it.
+Unlike the list option, the read option shows the schema passed as input and, in case of PLAIN category, the full
+attributes of the schema.
[source]
--
-You are runnig: schema --read PLAIN email
+You are running: schema --read PLAIN email
> SCHEMA ID: email
type: String
@@ -243,13 +243,13 @@ You are runnig: schema --read PLAIN email
mandatory condition: false
mime type: null
validator class: org.apache.syncope.core.persistence.jpa.attrvalue.validation.EmailAddressValidator
- chiper algorithm:
+ cipher algorithm:
--
[source]
--
-You are runnig: schema --read DERIVED info
+You are running: schema --read DERIVED info
###############################################################################
# #
@@ -269,7 +269,7 @@ You are runnig: schema --read DERIVED info
[source]
--
-You are runnig: schema --read VIRTUAL virtualReadOnly
+You are running: schema --read VIRTUAL virtualReadOnly
##################################
# #
@@ -300,4 +300,4 @@ The delete option, as can be imagined, tries to remove a specified schema.
[source]
--
- Schema {SCHEMA-KEY} successfully deleted
---
\ No newline at end of file
+--
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/src/main/asciidoc/cli/task.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli/task.adoc b/src/main/asciidoc/cli/task.adoc
index b57a535..fb1f573 100644
--- a/src/main/asciidoc/cli/task.adoc
+++ b/src/main/asciidoc/cli/task.adoc
@@ -18,7 +18,7 @@
//
==== Task command
-The connector command serves to retrieve the information around the connector configuration in Apache Syncope.
+The Task command retrieves information about the Task configuration in Apache Syncope.
===== Help message
[source,bash]
@@ -56,7 +56,7 @@ $ ./syncopeadm.sh task --details
[source]
--
-You are runnig: task --details
+You are running: task --details
##############################################################
# #
@@ -99,7 +99,7 @@ $ ./syncopeadm.sh - task --list {TASK-TYPE}
[source]
--
-You are runnig: task --list SCHEDULED
+You are running: task --list SCHEDULED
- Scheduled task key: 5
name: SampleJob Task
@@ -126,7 +126,7 @@ $ ./syncopeadm.sh task --list-running-jobs
[source]
--
- - There is NOT running jobs available
+ - There are NO running jobs available
--
===== List scheduled jobs
@@ -159,11 +159,11 @@ The option to read all the information of specified tasks.
$ ./syncopeadm.sh task --read {TASK-ID} {TASK-ID} [...]
--
-Unlike the list option, the read one shows only the tasks passed as input. Below the commad to read the task with
+Unlike the list option, the read option shows only the tasks passed as input. Below the commad to read the task with
id 13
[source]
--
-You are runnig: task --read 13
+You are running: task --read 13
- Push task key: 13
name: Export on resource-testdb2
@@ -195,34 +195,34 @@ $ ./syncopeadm.sh task --read-execution {TASK-EXEC-ID} {TASK-EXEC-ID} [...]
--
===== Delete option
-The option to delete a specified tasks.
+The option to delete specified tasks.
[source]
--
$ ./syncopeadm.sh task --delete {TASK-ID} TASK-ID} [...]
--
-The delete option, as can be imagined, tries to remove a specified tasks.
+The delete option, as can be imagined, tries to remove specified tasks.
[source]
--
- task {TASK-ID} successfully deleted
--
===== Delete execution option
-The option to delete a specified execution tasks.
+The option to delete specified execution tasks.
[source]
--
$ ./syncopeadm.sh task --delete {TASK-EXEC-ID} {TASK-EXEC-ID} [...]
--
-The delete option, as can be imagined, tries to remove a specified execution tasks.
+The delete option, as can be imagined, tries to remove specified execution tasks.
[source]
--
- task {TASK-EXEC-ID} successfully deleted
--
===== Execute option
-The option to execute a specified execution tasks.
+The option to execute specified execution tasks.
[source]
--
$ ./syncopeadm.sh task --execute {TASK-ID} {DRY-RUN}
@@ -232,7 +232,7 @@ $ ./syncopeadm.sh task --execute {TASK-ID} {DRY-RUN}
For instance, executing the PUSH task with id 13 in dry run mode the result is
[source]
--
- You are runnig: task --execute 13 false
+ You are running: task --execute 13 false
EXECUTIONS:
- task execution key: 0
task: 13
@@ -312,4 +312,4 @@ Any objects ignored:
status: SUCCESS
start date: Fri Nov 27 16:02:24 CET 2015
end date: Fri Nov 27 16:02:26 CET 2015
---
\ No newline at end of file
+--
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/src/main/asciidoc/cli/user.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli/user.adoc b/src/main/asciidoc/cli/user.adoc
index 155de69..ed2715c 100644
--- a/src/main/asciidoc/cli/user.adoc
+++ b/src/main/asciidoc/cli/user.adoc
@@ -18,7 +18,7 @@
//
==== User command
-The user command serves to retrieve the information about the users.
+The user command retrieves information about the users.
===== Help message
[source,bash]
@@ -59,7 +59,7 @@ $ ./syncopeadm.sh user --details
[source]
--
-You are runnig: user --details
+You are running: user --details
#################################
# #
@@ -82,8 +82,7 @@ You are runnig: user --details
--
===== List option
-Running the command with this option you will see the list of all user in the environment but, before the execution,
-the system will ask you a confirmation because as you can imagine this operation might produce very heavy output.
+Running the command with this option you will see the list of all users in the environment. However, the system will ask you a confirmation before execution, because as you can imagine this operation might produce very large output.
[source]
--
@@ -91,9 +90,9 @@ $ ./syncopeadm.sh user --list
--
[source]
--
-You are runnig: user --list
+You are running: user --list
-This operation might produce very heavy output. Do you want to continue? [yes/no]
+This operation might produce very large output. Do you want to continue? [yes/no]
yes
> USER ID: 2
@@ -131,7 +130,7 @@ RELATIONSHIPS:
--
===== Get user key option
-The option to get the user key starting from an username.
+The option to get the user key starting from a username.
[source]
--
@@ -140,13 +139,13 @@ $ ./syncopeadm.sh user --get-user-key {USERNAME}
[source]
--
-You are runnig: user --get-user-key rossini
+You are running: user --get-user-key rossini
- rossini user ID is 1
--
===== Get username option
-The option to get the username starting from an user id.
+The option to get the username starting from a user id.
[source]
--
@@ -155,13 +154,13 @@ $ ./syncopeadm.sh user --get-user-key {USER-ID}
[source]
--
-You are runnig: user --get-username 1
+You are running: user --get-username 1
- 1 username is rossini
--
===== Read by user id option
-The option to read user information by his user id.
+The option to read user information by their user id.
[source]
--
@@ -171,7 +170,7 @@ $ ./syncopeadm.sh user --read {USER-ID} {USER-ID} [...]
[source]
--
-You are runnig: user --read 1
+You are running: user --read 1
> USER ID: 1
username: rossini
@@ -210,7 +209,7 @@ RELATIONSHIPS:
--
===== Read by username option
-The option to read user information by his username.
+The option to read user information by their username.
[source]
--
@@ -220,7 +219,7 @@ $ ./syncopeadm.sh user --read {USERNAME} {USERNAME} [...]
[source]
--
-You are runnig: user --read rossini
+You are running: user --read rossini
> USER ID: 1
username: rossini
@@ -259,7 +258,7 @@ RELATIONSHIPS:
--
===== Search by attribute option
-The option to searcn a list of users with a common attribute.
+The option to search a list of users with a common attribute.
[source]
--
@@ -271,7 +270,7 @@ For instance if you want to search the active users under the root realm:
[source]
--
-You are runnig: user --search-by-attribute / status=active
+You are running: user --search-by-attribute / status=active
> USER ID: 2
username: verdi
@@ -317,7 +316,7 @@ RELATIONSHIPS:
--
===== Search by role option
-The option to searcn a list of users with a specified role.
+The option to search a list of users with a specified role.
[source]
--
@@ -327,7 +326,7 @@ $ ./syncopeadm.sh user --search-by-role {REALM} {ROLE-NAME}
[source]
--
-You are runnig: user --search-by-role / Other
+You are running: user --search-by-role / Other
> USER ID: 1
username: rossini
@@ -366,7 +365,7 @@ RELATIONSHIPS:
--
===== Search by resource option
-The option to searcn a list of users with a specified resource.
+The option to search a list of users with a specified resource.
[source]
--
@@ -376,7 +375,7 @@ $ ./syncopeadm.sh user --search-by-resource {REALM} {RESOURCE-NAME}
[source]
--
-You are runnig: user --search-by-resource / ws-target-resource-2
+You are running: user --search-by-resource / ws-target-resource-2
> USER ID: 3
username: vivaldi
@@ -472,27 +471,27 @@ $ ./syncopeadm.sh user --delete-by-attribute {REALM} {ATTR-NAME}={ATTR-VALUE}
[source]
--
- You are runnig: user --delete-by-attribute / surname=Rossini
+ You are running: user --delete-by-attribute / surname=Rossini
- Deleted users: 1
--
===== Delete all option
-The option to delete all users of the realm passe as input.
+The option to delete all users of the realm passed as input.
[source]
--
$ ./syncopeadm.sh user --delete-all {REALM}
--
-The delete option, as can be imagined, tries to remove every users under the passed realm.
+The delete option, as can be imagined, tries to remove every user under the specified realm.
[NOTE]
-To run this operation the system asks you again the admin credential.
+To run this operation the system asks you again for the admin credential.
[source]
--
-You are runnig: user --delete-all /
+You are running: user --delete-all /
Running this operation you will delete all the realm users managed by Syncope, are you sure? [yes/no]
yes
@@ -522,14 +521,13 @@ Deleting process started
--
-As you can read the output is composed of two parts.
-The first one is the number of deleted users; the second one is a table with the users (user id) don't removed.
+The output is composed of two parts. The first one is the number of deleted users; the second one is a table with the users (user id) who aren't removed.
To know the reason why the deletion failed you need to run the command with the standard delete option.
[source]
--
-You are runnig: user --delete 5
+You are running: user --delete 5
- Error: GroupOwnership [6 director]
---
\ No newline at end of file
+--
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/src/main/asciidoc/introduction.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/introduction.adoc b/src/main/asciidoc/introduction.adoc
index cd108e3..bb9d044 100644
--- a/src/main/asciidoc/introduction.adoc
+++ b/src/main/asciidoc/introduction.adoc
@@ -82,8 +82,8 @@ http://docs.spring.io/spring/docs/4.1.x/spring-framework-reference/html/transact
provided by the Spring Framework. +
Globally, this offers the ability to easily scale up to a million entities and at the same time allows great portability with no code
changes: MySQL, MariaDB, PostgreSQL, Oracle and MS SQL Server are fully supported deployment options.
- * *_Security_* defines a fine-grained set of entitlements which can be granted to administrators, thus allowing to
-implement real delegated administration scenarios.
+ * *_Security_* defines a fine-grained set of entitlements which can be granted to administrators, thus enabling the
+implementation of delegated administration scenarios.
[.text-center]
image::architecture.png[title="Architecture",alt="Architecture"]
@@ -97,11 +97,11 @@ for delegated administration.
system administrators.
Third-party applications are provided full access to IdM services by leveraging the REST interface, either via the
-Java _SyncopeClient_ library (at the basis of Admin UI, End-user UI and CLI) or plain HTTP calls.
+Java _SyncopeClient_ library (the basis of Admin UI, End-user UI and CLI) or plain HTTP calls.
.ConnId
****
-The *_Provisioning_* layer relays on http://connid.tirasa.net[ConnId^]; ConnId is designed to separate the
+The *_Provisioning_* layer relies on http://connid.tirasa.net[ConnId^]; ConnId is designed to separate the
implementation of an application from the dependencies of the system that the application is attempting to connect to.
ConnId is the continuation of The Identity Connectors Framework (Sun ICF), a project that used to be part of market
http://git-wip-us.apache.org/repos/asf/syncope/blob/b4f89390/src/main/asciidoc/obtain.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/obtain.adoc b/src/main/asciidoc/obtain.adoc
index b318964..1fe2c40 100644
--- a/src/main/asciidoc/obtain.adoc
+++ b/src/main/asciidoc/obtain.adoc
@@ -326,7 +326,7 @@ artifactId::
something like 'myproject'
version number::
You can use the default; it is good practice to have 'SNAPSHOT' in the version number during development and the
-maven release plugin makes use of that string. But ensure to comply to the desired numbering scheme for your project.
+maven release plugin makes use of that string. But ensure to comply with the desired numbering scheme for your project.
package name::
The java package name. A folder structure according to this name will be generated automatically; by default, equal
to the groupId.
@@ -351,7 +351,7 @@ After downloading all of the needed dependencies, two WAR files will be produced
If no failures are encountered, your basic Apache Syncope project is now ready to go.
[NOTE]
-You should consider reading the _Apache Syncope Reference Guide_ for understanding how to configure, extend, customize
+You should consider reading the _Apache Syncope Reference Guide_ to understand how to configure, extend, customize
and deploy your new Apache Syncope project.
==== Embedded Mode