Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added content to the Using the Admin Console section of the Reference Guide #19

Closed
wants to merge 2 commits into from

Conversation

tmess567
Copy link
Contributor

I have added some content to the "Using the Admin Console" section for the Reference Guide along with screenshots for the same. Please suggest any required changes or addition / removal screenshots.

Also, I will need help to understand the usage of Types and Workflow tabs in the Configurations part of the admin console so that I can add documentation for it.

@ilgrosso
Copy link
Member

Hi @tmess567 thanks for this initiative!
I will review this PR soon, please keep adding commits to it.

Please also refer to SYNCOPE-700 in the commit log message, thanks.

@@ -31,7 +31,7 @@ operating system. +

. http://maven.apache.org/[Apache Maven^] (version 3.0.3 or higher) installed
. one of the supported <<internal-storage,DBMSes>> up and running
. one of the supported <<java-ee-container, Java EE containers>> up and running
. one of the supported <<java-ee-container, Java EE containers>> up and running
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please void this whitespace changes.

@ilgrosso
Copy link
Member

You need to make the following modification, otherwise your changes won't be included in the generated PDF / HTML:

ilgrosso@sequoia:~/work/syncope/syncope2$ git diff
diff --git a/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc b/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc
index a451889..9dd208e 100644
--- a/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc
+++ b/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc
@@ -27,7 +27,7 @@ include::installation/installation.adoc[]

 == Working with Apache Syncope

-=== Using the Admin Console
+include::adminconsole/adminconsole.adoc[]

 include::cli/cli.adoc[]

resources available and configured in the syncope deployment. It also allows the admin to perform
all the actions listed in the realms tab.

image::consoleTopology.png[console-topology]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be better to include here the screenshot from -Pembedded rather than the one from standalone distribution, since in the latter there is no local connector bundles, only connector server.

@ilgrosso
Copy link
Member

Also, I will need help to understand the usage of Types and Workflow tabs in the Configurations part of the admin console so that I can add documentation for it.

Types

The Types entry allows to define and maintain the internal data model:

  • schema - defines which attribute types are available
  • classes: group schemas (similar to LDAP object classes)
  • types: allow to assign structural classes to any types (e.g. USER, GROUP, PRINTER, whatever) so that you can determine which attributes are available for users, groups and printers
  • relationship types: defines which relationships can occur between users and any objects or any objects and other any objects

Workflow

See https://cwiki.apache.org/confluence/display/SYNCOPE/User+Workflow

@tmess567
Copy link
Contributor Author

Can I just reuse the above text (for types description) and also the one at https://cwiki.apache.org/confluence/display/SYNCOPE/User+Workflow or do I need to make any changes?

@ilgrosso
Copy link
Member

You can of course use the text above as starting point, but it would be nice to expand some concepts.
Same applies to wiki page.

@ilgrosso
Copy link
Member

ilgrosso commented Jul 1, 2016

@tmess567 if you don't mind, I'll merge this PR as it is right now and continue working from here, since I am about to start again on SYNCOPE-700.
Fine with you?

@tmess567
Copy link
Contributor Author

tmess567 commented Jul 1, 2016

Yeah sure, I will continue to work on this locally whenever I get the time and create a new PR when done.

@ilgrosso
Copy link
Member

ilgrosso commented Jul 1, 2016

Thanks!

@asfgit asfgit closed this in c525611 Jul 1, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants