Repository: syncope Updated Branches: refs/heads/master 92e8ecc48 -> e8c939772
More docs review Project: http://git-wip-us.apache.org/repos/asf/syncope/repo Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/e8c93977 Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/e8c93977 Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/e8c93977 Branch: refs/heads/master Commit: e8c93977299c714b3c4059ddd0db8df0730ba4f6 Parents: 92e8ecc Author: Colm O hEigeartaigh <cohei...@apache.org> Authored: Fri Aug 26 10:20:30 2016 +0100 Committer: Colm O hEigeartaigh <cohei...@apache.org> Committed: Fri Aug 26 10:20:30 2016 +0100 ---------------------------------------------------------------------- .../asciidoc/reference-guide/concepts/audit.adoc | 4 ++-- .../asciidoc/reference-guide/concepts/domains.adoc | 2 +- .../reference-guide/concepts/extensions.adoc | 10 +++++----- .../asciidoc/reference-guide/concepts/reports.adoc | 16 ++++++++-------- .../asciidoc/reference-guide/concepts/tasks.adoc | 16 ++++++++-------- .../adminconsole/adminconsole.adoc | 2 +- .../adminconsole/approval.adoc | 2 +- .../adminconsole/configuration.adoc | 8 ++++---- .../adminconsole/dashboard.adoc | 2 +- .../adminconsole/realms.adoc | 2 +- .../adminconsole/topology.adoc | 4 ++-- .../workingwithapachesyncope/cli/notification.adoc | 4 ++-- .../workingwithapachesyncope/cli/question.adoc | 4 ++-- .../workingwithapachesyncope/cli/resource.adoc | 2 +- .../workingwithapachesyncope/cli/role.adoc | 2 +- .../workingwithapachesyncope/cli/task.adoc | 2 +- .../workingwithapachesyncope/cli/user.adoc | 12 ++++++------ .../workingwithapachesyncope.adoc | 4 ++-- 18 files changed, 49 insertions(+), 49 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/syncope/blob/e8c93977/src/main/asciidoc/reference-guide/concepts/audit.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/concepts/audit.adoc b/src/main/asciidoc/reference-guide/concepts/audit.adoc index 5ae007a..476fdfd 100644 --- a/src/main/asciidoc/reference-guide/concepts/audit.adoc +++ b/src/main/asciidoc/reference-guide/concepts/audit.adoc @@ -30,5 +30,5 @@ An example of how audit entries can be extracted for reporting is shown by the < ==== Audit Events -What described for <<notification-events,notification events>> is also valid for audit events, examples included - -except for admin console <<console-configuration-audit,tooling>>, which is naturally distinct. +The information provided for <<notification-events,notification events>> is also valid for audit events, including examples - +except for the admin console <<console-configuration-audit,tooling>>, which is naturally distinct. http://git-wip-us.apache.org/repos/asf/syncope/blob/e8c93977/src/main/asciidoc/reference-guide/concepts/domains.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/concepts/domains.adoc b/src/main/asciidoc/reference-guide/concepts/domains.adoc index cab6ef0..9ffdbd3 100644 --- a/src/main/asciidoc/reference-guide/concepts/domains.adoc +++ b/src/main/asciidoc/reference-guide/concepts/domains.adoc @@ -31,6 +31,6 @@ image::domains.png[title="Domains",alt="Domains"] [TIP] ==== -Each domain's persistence unit can be configured to work with one of <<persistence,supported DBMSes>>: `Master` can be +Each domain's persistence unit can be configured to work with one of the <<persistence,supported DBMSes>>: `Master` can be on MySQL, `Domain1` on PostgreSQL, `DomainN` on Oracle and so on. ==== http://git-wip-us.apache.org/repos/asf/syncope/blob/e8c93977/src/main/asciidoc/reference-guide/concepts/extensions.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/concepts/extensions.adoc b/src/main/asciidoc/reference-guide/concepts/extensions.adoc index 62b545e..360395e 100644 --- a/src/main/asciidoc/reference-guide/concepts/extensions.adoc +++ b/src/main/asciidoc/reference-guide/concepts/extensions.adoc @@ -18,8 +18,8 @@ // === Extensions -Extensions allow to optionally enrich the _vanilla_ Apache Syncope with useful features, without the need of bloating -every single deployment with non-needed libraries and configurations. +The _vanilla_ Apache Syncope deployment can be optional enriched with useful features via an Extension, instead of bloating +every single deployment with unneeded libraries and configurations. With reference to <<architecture,architecture>>, an extension might add a <<rest>> endpoint, manage the <<persistence,persistence>> of additional entities, extend the <<security,security>> mechanisms, tweak the @@ -31,7 +31,7 @@ Extensions are available from different sources: . as Maven artifacts published from the Apache Syncope codebase, part of the official releases - this is the case of the ones detailed below; . as Maven artifacts published by third parties; -. as part of a given deployment sources, as explained <<customization-extensions, in the following>>. +. as part of a given deployment source code, as explained <<customization-extensions, in the following>>. ==== Apache Camel Provisioning Engine @@ -61,7 +61,7 @@ endif::[] [TIP] ==== -This extension is adding features to all components and layers available and can be taken as reference when creating +This extension adds features to all components and layers that are available, and can be taken as reference when creating <<customization-extensions,new extensions>>. ==== @@ -81,7 +81,7 @@ where `protocol`, `host` and `port` reflect your Java EE container installation. [NOTE] .Extension Sources ==== -The sources of this extension are available from the Apache Syncope +The source code of this extension is available from the Apache Syncope ifeval::["{snapshotOrRelease}" == "release"] https://github.com/apache/syncope/tree/syncope-{docVersion}/ext/swagger-ui[source tree^] endif::[] http://git-wip-us.apache.org/repos/asf/syncope/blob/e8c93977/src/main/asciidoc/reference-guide/concepts/reports.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/concepts/reports.adoc b/src/main/asciidoc/reference-guide/concepts/reports.adoc index 8125f63..8dc3346 100644 --- a/src/main/asciidoc/reference-guide/concepts/reports.adoc +++ b/src/main/asciidoc/reference-guide/concepts/reports.adoc @@ -25,7 +25,7 @@ A report is essentially defined by a <<report-templates,template>> and a sequenc the latter is responsible for extracting the required information and the former defines how execution results will be presented, in the various available formats. -Reports can be execute upon request or scheduled: executions result can be downloaded as: +Reports can be executed upon request or scheduled: execution results can be downloaded as: * XML * HTML @@ -45,7 +45,7 @@ will be then made available as PDF and RTF [NOTE] ==== -Report templates can be easily managed either via <<console-reports,admin console>> or <<eclipse-ide-plugin>>. +Report templates can be easily managed either via the <<console-reports,admin console>> or the <<eclipse-ide-plugin>>. ==== ==== Reportlets @@ -70,10 +70,10 @@ ifeval::["{snapshotOrRelease}" == "snapshot"] https://github.com/apache/syncope/blob/master/common/lib/src/main/java/org/apache/syncope/common/lib/report/AbstractReportletConf.java[AbstractReportletConf^] endif::[] and embedding the configuration options that can be tuned when incorporating a given reportlet into a report; when -properly annotated, such options are manageable via <<console-reports,admin console>> +properly annotated, such options are manageable via the <<console-reports,admin console>> -Some reportlets are available by default (and briefly presented below) either for direct usage and for acting as -reference when building new reportlets for specific Apache Syncope deployments. +Some reportlets are available by default (and briefly presented below) either for direct usage or for acting as +a reference when building new reportlets for specific Apache Syncope deployments. ===== Static Reportlet @@ -91,7 +91,7 @@ endif::[] ifeval::["{snapshotOrRelease}" == "snapshot"] https://github.com/apache/syncope/blob/master/common/lib/src/main/java/org/apache/syncope/common/lib/report/StaticReportletConf.java[StaticReportletConf^], endif::[] -it is essentially an handy way to inject static values (of various types) into a report. +it is essentially a handy way to inject static values (of various types) into a report. ===== User and Group Reportles Defined by @@ -108,7 +108,7 @@ endif::[] ifeval::["{snapshotOrRelease}" == "snapshot"] https://github.com/apache/syncope/blob/master/common/lib/src/main/java/org/apache/syncope/common/lib/report/UserReportletConf.java[UserReportletConf^], endif::[] -it can be used for reporting various information about Users available in the internal storage, their attributes, +it can be used to report various information about Users available in the internal storage, their attributes, memberships and relationships, external resources and so on. A similar reportlet is also available for Groups, defined by @@ -147,7 +147,7 @@ e.g. whether such entities are available on all Identity Stores matching the ass <<external-resources,external resources>> and, if so, whether the <<mapping,mapped>> attributes feature the expected values. -An instance of reconciliation reportlet is run by default from admin console's <<dashboard,dashboard>>, and results +An instance of reconciliation reportlet is run by default from the admin console's <<dashboard,dashboard>>, and results are available as a widget. ===== Audit Reportlet http://git-wip-us.apache.org/repos/asf/syncope/blob/e8c93977/src/main/asciidoc/reference-guide/concepts/tasks.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/concepts/tasks.adoc b/src/main/asciidoc/reference-guide/concepts/tasks.adoc index 2c50840..5218b97 100644 --- a/src/main/asciidoc/reference-guide/concepts/tasks.adoc +++ b/src/main/asciidoc/reference-guide/concepts/tasks.adoc @@ -18,7 +18,7 @@ // === Tasks -Tasks control the effective operations ongoing in the <<core>>. +Tasks control the effective operations that are ongoing in the <<core>>. Whilst tasks define what and how to perform, they are supposed to be run by some entity (depending on the actual task type, see below for details); their execution result can be saved for later examination. @@ -26,7 +26,7 @@ type, see below for details); their execution result can be saved for later exam [[tasks-propagation]] ==== Propagation -A propagation task encapsulates all the information required - according to the defined <<mapping,mapping>> - to create, +A propagation task encapsulates all the information that is required - according to the defined <<mapping,mapping>> - to create, update or delete a given User, Group or Any Object, to / from a certain Identity Store: * operation - `CREATE`, `UPDATE` or `DELETE` @@ -85,7 +85,7 @@ When defining a pull task, the following information must be provided: [NOTE] ==== -Pull tasks are executed, either upon request or because scheduled, via the +Pull tasks are executed, either upon request or due to a schedule, via the ifeval::["{snapshotOrRelease}" == "release"] https://github.com/apache/syncope/blob/syncope-{docVersion}/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/pushpull/PullJobDelegate.java[PullJobDelegate^] endif::[] @@ -116,7 +116,7 @@ When defining a push task, the following information must be provided: [NOTE] ==== -Push tasks are executed, either upon request or because scheduled, via the +Push tasks are executed, either upon request or due to a schedule, via the ifeval::["{snapshotOrRelease}" == "release"] https://github.com/apache/syncope/blob/syncope-{docVersion}/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/pushpull/PushJobDelegate.java[PushJobDelegate^] endif::[] @@ -131,7 +131,7 @@ the execution details - depending on the trace level set on the related [[tasks-notification]] ==== Notification -A notification tasks encapsulates all the information required for sending out a notification e-mail, according to the +A notification task encapsulates all the information that is required to send out a notification e-mail, according to the specification provided in a given <<notifications,notification>>: * entity - reference to the internal identity - User, Group or Any Object - the notification task refers to @@ -163,7 +163,7 @@ and are permanently saved - for later re-execution or for examining the executio [[tasks-custom]] ==== Custom -Custom tasks allow to inject logic into the <<core>>, available for execution and scheduling. +Custom tasks allow for the injection of logic into the <<core>> in the area of execution and scheduling. When defining a custom task, the following information must be provided: @@ -184,8 +184,8 @@ providing the custom logic to execute Custom tasks are ideal for implementing periodic checks or clean-up operations, possibly in coordination with other components; some examples: -* move users from "peding delete" to "deleted" status 15 days after they reached the "pending delete" status (requires +* move users from "pending delete" to "deleted" status 15 days after they reached the "pending delete" status (requires interaction with <<activiti-user-workflow-adapter>>) * send out notification e-mails to users whose password is about to expire on an Identity Store -* disable all users not logging in into the system for the past 6 months +* disable all users not logging into the system for the past 6 months ==== http://git-wip-us.apache.org/repos/asf/syncope/blob/e8c93977/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/adminconsole.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/adminconsole.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/adminconsole.adoc index 3be76c6..c9e124f 100644 --- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/adminconsole.adoc +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/adminconsole.adoc @@ -25,7 +25,7 @@ protocol://host:port/syncope-console/ where `protocol`, `host` and `port` reflect your Java EE container installation. -You should be greeted with the following web page. +You should be greeted by the following web page. image::consoleLogin.png[console-login] http://git-wip-us.apache.org/repos/asf/syncope/blob/e8c93977/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/approval.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/approval.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/approval.adoc index 1d30904..d6d6b88 100644 --- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/approval.adoc +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/approval.adoc @@ -20,7 +20,7 @@ [[console-approval]] ===== Approval -The images below refers to the self-registration approval <<sample-selfreg-approval,sample>> and to the typical approval +The images below refer to the self-registration approval <<sample-selfreg-approval,sample>> and to the typical approval flow as explained <<approval,above>>. image::approval1.png[title="Approval notification",alt="Approval notification"] http://git-wip-us.apache.org/repos/asf/syncope/blob/e8c93977/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/configuration.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/configuration.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/configuration.adoc index 1c4c6df..8bcf9c3 100644 --- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/configuration.adoc +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/configuration.adoc @@ -24,13 +24,13 @@ organization. [[console-configuration-audit]] Audit:: -Allows to configure the <<audit,auditing>> features. +Controls the configuration of the <<audit,auditing>> features. [[console-configuration-logs]] Logs:: The logging levels available can be dynamically adjusted; for example, the admin can set it -to display only the errors of `io.swagger`, in which case the warnings and information logs will not be reported. +to display only the errors of `io.swagger`, in which case the warning and information logs will not be reported. [[console-configuration-notifications]] Notifications:: @@ -41,10 +41,10 @@ This page also allows the administators to create and edit <<notification-templa [[console-configuration-parameters]] Parameters:: -Presents the administrators with the list of defined <<configuration-parameters,configurtion parameters>> used in the +Presents the administrators with the list of defined <<configuration-parameters,configuration parameters>> used in the given deployment such as `token.expireTime` and `password.cipher.algorithm`. These can be edited to further customize the deployment. + -New parameters can also be added, for usage with custom code. +New parameters can also be added, for use with custom code. [[console-configuration-policies]] Policies:: http://git-wip-us.apache.org/repos/asf/syncope/blob/e8c93977/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/dashboard.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/dashboard.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/dashboard.adoc index cbc5f63..ce8c857 100644 --- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/dashboard.adoc +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/dashboard.adoc @@ -19,6 +19,6 @@ ===== Dashboard The dashboard provides an overall view of the current state of the Apache Syncope deployment. It -consists of various widgets and tabs that show the different metrics and details of each component available. +consists of various widgets and tabs that show the different metrics and details of each component that is available. image::consoleDashboard.png[console-dashboard] http://git-wip-us.apache.org/repos/asf/syncope/blob/e8c93977/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/realms.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/realms.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/realms.adoc index 701f021..00c0b42 100644 --- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/realms.adoc +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/realms.adoc @@ -20,6 +20,6 @@ ===== Realms The realms page provides the designated administators with the power to manage <<realms>> as well as -<<users-groups-and-any-objects>>, for all <<anytype, Any Types>> defined. +<<users-groups-and-any-objects>>, for all <<anytype, Any Types>> that are defined. image::realmsUser.png[console-realms-user] http://git-wip-us.apache.org/repos/asf/syncope/blob/e8c93977/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/topology.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/topology.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/topology.adoc index bd281f0..7d0f5fb 100644 --- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/topology.adoc +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/topology.adoc @@ -18,8 +18,8 @@ // ===== Topology -The topology page provides a mapped view of the available <<connector-instance-details,connectors>> and -<<external-resource-details,external resources>> available and configured in the given deployment. + +The topology page provides a mapped view of the <<connector-instance-details,connectors>> and +<<external-resource-details,external resources>> that are available and configured in the given deployment. + Different actions are available when clicking on the various nodes. image::consoleTopology.png[console-topology] http://git-wip-us.apache.org/repos/asf/syncope/blob/e8c93977/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/notification.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/notification.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/notification.adoc index a79073a..5b3744b 100644 --- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/notification.adoc +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/notification.adoc @@ -37,8 +37,8 @@ Usage: notification [options] ====== Options --list:: -Running the command with this option you will see the list of notificaitons with their configuration. +Running the command with this option you will see the list of notifications with their configuration. --read:: The option to read all the information of the specified notifications. --delete:: -The option to delete a specified notification. \ No newline at end of file +The option to delete a specified notification. http://git-wip-us.apache.org/repos/asf/syncope/blob/e8c93977/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/question.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/question.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/question.adoc index 624f33d..3298230 100644 --- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/question.adoc +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/question.adoc @@ -17,7 +17,7 @@ // under the License. // ===== Question command -This command works with security questions for usage with <<password-reset,password reset>>. +This command works with security questions for use with <<password-reset,password reset>>. [discrete] ====== Help message @@ -41,4 +41,4 @@ Running the command with this option you will see the list of questions with the --read:: The option to read all the information of specified questions. --delete:: -The option to delete a specified question. \ No newline at end of file +The option to delete a specified question. http://git-wip-us.apache.org/repos/asf/syncope/blob/e8c93977/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/resource.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/resource.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/resource.adoc index c8433b0..1db624c 100644 --- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/resource.adoc +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/resource.adoc @@ -38,7 +38,7 @@ Usage: resource [options] ====== Options --details:: -This option shows a table with amount of available resources. +This option shows a table with the amount of available resources. --list:: Running the command with this option you will see the list of resources. --read:: http://git-wip-us.apache.org/repos/asf/syncope/blob/e8c93977/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/role.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/role.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/role.adoc index 7214711..471c388 100644 --- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/role.adoc +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/role.adoc @@ -40,7 +40,7 @@ Usage: role [options] --details:: This option shows a table with some details about the roles. --list:: -Running the command with this option you will see the list of roles with the realm where they 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 entitlements. --read:: The option to read all the information of specified roles. --delete:: http://git-wip-us.apache.org/repos/asf/syncope/blob/e8c93977/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/task.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/task.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/task.adoc index d4ddc94..0f12ad8 100644 --- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/task.adoc +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/task.adoc @@ -55,7 +55,7 @@ Running the command with this option you will see the list of selected tasks typ --list-scheduled-jobs:: Running the command with this option you will see the list of the actual scheduled jobs. --list-running-jobs:: -Running the command with this option you will see the list of the actual runnig jobs. +Running the command with this option you will see the list of the actual running jobs. --read:: The option to read all the information of a task. --read-execution:: http://git-wip-us.apache.org/repos/asf/syncope/blob/e8c93977/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/user.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/user.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/user.adoc index 542c5b9..6aeffff 100644 --- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/user.adoc +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/cli/user.adoc @@ -55,9 +55,9 @@ Usage: user [options] --details:: This option shows a table with some details about the Users. --- List option:: +--list:: 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. +ask you a confirmation before execution, because as you can imagine this operation might produce a very large output. --get-user-key:: The option to get the user key starting from a username. --get-username:: @@ -72,9 +72,9 @@ The option to search a list of Users with a common attribute. The option to search a list of Users with a specified role. --search-by-resource:: The option to search a list of Users with a specified resource. ---delete +--delete:: The option to delete a specified user. ---delete-by-attribute +--delete-by-attribute:: The option to delete the Users with a common attribute. ---delete-all -The option to delete all Users of the realm passed as input. \ No newline at end of file +--delete-all:: +The option to delete all Users of the realm passed as input. http://git-wip-us.apache.org/repos/asf/syncope/blob/e8c93977/src/main/asciidoc/reference-guide/workingwithapachesyncope/workingwithapachesyncope.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/workingwithapachesyncope.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/workingwithapachesyncope.adoc index 29b817a..8920391 100644 --- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/workingwithapachesyncope.adoc +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/workingwithapachesyncope.adoc @@ -18,7 +18,7 @@ // == Working with Apache Syncope -Before moving forward, please ensure to have access to an Apache Syncope running deployment. +Before proceeding, please ensure that you have access to a running Apache Syncope deployment. You can take a look at the ifeval::["{backend}" == "html5"] http://syncope.apache.org/docs/getting-started.html[Apache Syncope Getting Started Guide] @@ -26,7 +26,7 @@ endif::[] ifeval::["{backend}" == "pdf"] http://syncope.apache.org/docs/getting-started.pdf[Apache Syncope Getting Started Guide] endif::[] -to check system requirements and choose among the various options for obtaining Apache Syncope. +to check system requirements and to choose among the various options for obtaining Apache Syncope. include::adminconsole/adminconsole.adoc[]
