Re: Apache Syncope documentation
Hi all, right before packing my things for Budapest, I've just pushed an update on the Getting Started guide, which is currently half-way: the missing content should be easy to adapt from some wiki pages. Please check the latest status and let me know: http://ilgrosso.github.io/syncope2/getting-started.html http://ilgrosso.github.io/syncope2/getting-started.pdf For those of you that are going to ApacheCon: see you there! Regards. On 29/09/2015 15:19, Francesco Chicchiriccò wrote: On 29/09/2015 08:36, Marco Di Sabatino Di Diodoro wrote: Hi Francesco, Il 28/09/2015 18:22, Francesco Chicchiriccò ha scritto: Hi, I've opened SYNCOPE-700 to track this work. You can find the initial work rendered at [8] (under the "New documentation" title), with the two guides I believe are required, both available as HTML and PDF. As written below, I've added the POM configuration for generating such documentation via AsciiDoctor, in a separate "doc" build profile, and some initial skeleton with commit [9]. Naturally, several things need to be improved (footer content over all) and, mainly, the actual content is to be written. Meanwhile, can you take a look at proposed Table Of Contents and let me have your feedback? It sounds good. I propose adding the following chapters: 3.6 Notifications 3.7 Audits Marco, I have updated the TOC including the two items above and completed (at least for the moment) the work on aspect, both for PDF and HTML. [8] was also updated. ...time to start writing some actual content! Regards. On 28/09/2015 14:06, Francesco Chicchiriccò wrote: On 28/09/2015 13:18, Marco Di Sabatino Di Diodoro wrote: Hi all, this morning I found this thesis [1]. I disagree about some points, but I note with regret that the documentation of Apache Syncope is not complete and exhaustive. There are many features that are currently not explained anywhere. With this mail I would like to invite all of you to work together to make Syncope more attractive and interesting. WDYT? Marco, I completely agree with you. I see the great amount of inexact and / or misunderstood facts reported in [1] (but also in [2]) and I am getting more and more convinced that we absolutely need to produce a comprehensive documentation, to be maintained and aligned with software releases (as OpenJPA does [3], for example) rather than a loosely coupled stack of ageing wiki pages. I am ready to open an issue on JIRA for this, and I also volunteer for setting up the initial structure and tooling. My idea is that an adequate tool for this job needs to: 1. bundled to Maven build and (possibly) Maven site 2. produce at least HTML and PDF output 3. be diffuse enough I've seen that Docbkx [4] and the related Maven plugin [5] are quite stable and fulfils the requirements above . I'd rather go with AsciiDoc [6] and related Maven plugin [7], claiming to do all that and also be fast (and "à la page" nowadays, it seems). WDYT? [1] https://www.theseus.fi/bitstream/handle/10024/92040/Viitanen_Samu.pdf?sequence=1 [2] https://compare.evolveum.com/details-syncope.html [3] http://openjpa.apache.org/builds/2.4.0/apache-openjpa/docs/main.html [4] http://docbkx-tools.sourceforge.net/ [5] http://blog.javaforge.net/post/30820930927/generating-project-documentation-with-maven-docbook-docb [6] http://asciidoctor.org/ [7] http://asciidoctor.org/docs/asciidoctor-maven-plugin/ [8] http://ilgrosso.github.io/syncope2/ [9] http://git-wip-us.apache.org/repos/asf/syncope/commit/5dc51917 -- Francesco Chicchiriccò Tirasa - Open Source Excellence http://www.tirasa.net/ Involved at The Apache Software Foundation: member, Syncope PMC chair, Cocoon PMC, Olingo PMC http://people.apache.org/~ilgrosso/
[jira] [Commented] (SYNCOPE-700) Documentation artifacts
[
https://issues.apache.org/jira/browse/SYNCOPE-700?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14936835#comment-14936835
]
ASF subversion and git services commented on SYNCOPE-700:
-
Commit 931c6de5b7a6a15dafc75fc447230ea4b31675f2 in syncope's branch
refs/heads/master from [~ilgrosso]
[ https://git-wip-us.apache.org/repos/asf?p=syncope.git;h=931c6de ]
[SYNCOPE-700] Getting Started: half done
> Documentation artifacts
> ---
>
> Key: SYNCOPE-700
> URL: https://issues.apache.org/jira/browse/SYNCOPE-700
> Project: Syncope
> Issue Type: Improvement
> Components: documentation
>Reporter: Francesco Chicchiriccò
>Assignee: Francesco Chicchiriccò
> Fix For: 2.0.0
>
>
> As [discussed|http://markmail.org/message/dpleneuzrfcsmq2r] in mailing list,
> setup the {{asciidoctor-maven-plugin}} in order to generate, alongside with
> the build, the project documentation in HTML and PDF.
> The generated documentation will then be part of release artifacts and always
> up-to-date with current release.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
[jira] [Reopened] (SYNCOPE-166) Investigate using Apache Shiro to provide AM features
[ https://issues.apache.org/jira/browse/SYNCOPE-166?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Francesco Chicchiriccò reopened SYNCOPE-166: > Investigate using Apache Shiro to provide AM features > -- > > Key: SYNCOPE-166 > URL: https://issues.apache.org/jira/browse/SYNCOPE-166 > Project: Syncope > Issue Type: Task >Reporter: Francesco Chicchiriccò > -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Closed] (SYNCOPE-166) Investigate using Apache Shiro to provide AM features
[ https://issues.apache.org/jira/browse/SYNCOPE-166?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Francesco Chicchiriccò closed SYNCOPE-166. -- > Investigate using Apache Shiro to provide AM features > -- > > Key: SYNCOPE-166 > URL: https://issues.apache.org/jira/browse/SYNCOPE-166 > Project: Syncope > Issue Type: Task >Reporter: Francesco Chicchiriccò > -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Resolved] (SYNCOPE-166) Investigate using Apache Shiro to provide AM features
[ https://issues.apache.org/jira/browse/SYNCOPE-166?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Francesco Chicchiriccò resolved SYNCOPE-166. Resolution: Duplicate > Investigate using Apache Shiro to provide AM features > -- > > Key: SYNCOPE-166 > URL: https://issues.apache.org/jira/browse/SYNCOPE-166 > Project: Syncope > Issue Type: Task >Reporter: Francesco Chicchiriccò > -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Updated] (SYNCOPE-166) Investigate using Apache Shiro to provide AM features
[ https://issues.apache.org/jira/browse/SYNCOPE-166?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Francesco Chicchiriccò updated SYNCOPE-166: --- Fix Version/s: (was: 3.0.0) > Investigate using Apache Shiro to provide AM features > -- > > Key: SYNCOPE-166 > URL: https://issues.apache.org/jira/browse/SYNCOPE-166 > Project: Syncope > Issue Type: Task >Reporter: Francesco Chicchiriccò > -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Closed] (SYNCOPE-166) Investigate using Apache Shiro to provide AM features
[ https://issues.apache.org/jira/browse/SYNCOPE-166?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Francesco Chicchiriccò closed SYNCOPE-166. -- Resolution: Fixed > Investigate using Apache Shiro to provide AM features > -- > > Key: SYNCOPE-166 > URL: https://issues.apache.org/jira/browse/SYNCOPE-166 > Project: Syncope > Issue Type: Task >Reporter: Francesco Chicchiriccò > -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Created] (SYNCOPE-701) New end-user UI
Francesco Chicchiriccò created SYNCOPE-701: -- Summary: New end-user UI Key: SYNCOPE-701 URL: https://issues.apache.org/jira/browse/SYNCOPE-701 Project: Syncope Issue Type: New Feature Reporter: Francesco Chicchiriccò Fix For: 2.0.0 Before SYNCOPE-156, the admin console used to offer self-service features like as self-registration, profile maintenance and password reset. The idea is to built a separate web application providing such features; some requirements: # extremely customizable on deployment basis: not only look & feel, but also application logic (this sets one of glamour JS frameworks -as AngularJS - as candidate) # keep admin UI attitude of being gateway for accessing REST services exposed by core: this might require to build a sort of 'proxy' application to be contacted by client-side JS code -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (SYNCOPE-129) Delegation
[ https://issues.apache.org/jira/browse/SYNCOPE-129?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14936785#comment-14936785 ] Francesco Chicchiriccò commented on SYNCOPE-129: Shiro has the "Run As" feature which can be leveraged to implement this. > Delegation > -- > > Key: SYNCOPE-129 > URL: https://issues.apache.org/jira/browse/SYNCOPE-129 > Project: Syncope > Issue Type: New Feature >Reporter: Francesco Chicchiriccò > Fix For: 2.0.0 > > > Provide the ability for a user A to act as if he was user B when dealing with > Syncope. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (SYNCOPE-156) New admin UI
[ https://issues.apache.org/jira/browse/SYNCOPE-156?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14936751#comment-14936751 ] ASF subversion and git services commented on SYNCOPE-156: - Commit 2a7cf5aebc31752501bc2ba88e8b0cd41138ae02 in syncope's branch refs/heads/SYNCOPE-156 from [~fmartelli] [ https://git-wip-us.apache.org/repos/asf?p=syncope.git;h=2a7cf5a ] [SYNCOPE-156] merge confirmation on resource/connector deletion > New admin UI > > > Key: SYNCOPE-156 > URL: https://issues.apache.org/jira/browse/SYNCOPE-156 > Project: Syncope > Issue Type: New Feature > Components: console >Reporter: Francesco Chicchiriccò > Fix For: 2.0.0 > > > Refactor and rewrite current console into a new, cleaner, admin UI. > It is a important usability improvement to provide sensible and contextual > help messages on (mostly) each form field. > [1] > http://syncope-dev.1063484.n5.nabble.com/About-admin-console-refactoring-td5710115.html > [2] http://markmail.org/message/wtamknssq42pyjjc -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (SYNCOPE-156) New admin UI
[ https://issues.apache.org/jira/browse/SYNCOPE-156?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14936609#comment-14936609 ] ASF subversion and git services commented on SYNCOPE-156: - Commit 21262a6f3c87bd4c4aebe07400ed8bac78b06239 in syncope's branch refs/heads/SYNCOPE-156 from [~mdisabatino] [ https://git-wip-us.apache.org/repos/asf?p=syncope.git;h=21262a6 ] [SYNCOPE-156] Add confirm dialog > New admin UI > > > Key: SYNCOPE-156 > URL: https://issues.apache.org/jira/browse/SYNCOPE-156 > Project: Syncope > Issue Type: New Feature > Components: console >Reporter: Francesco Chicchiriccò > Fix For: 2.0.0 > > > Refactor and rewrite current console into a new, cleaner, admin UI. > It is a important usability improvement to provide sensible and contextual > help messages on (mostly) each form field. > [1] > http://syncope-dev.1063484.n5.nabble.com/About-admin-console-refactoring-td5710115.html > [2] http://markmail.org/message/wtamknssq42pyjjc -- This message was sent by Atlassian JIRA (v6.3.4#6332)
