[keycloak-dev] minimum doc requirements?

[Bill Burke]

I want documentation too, but screen casts are easier to put together, 
and this is an alpha release.  In the end, I'd like to have screen casts 
and docs that compliment each other.  Its often hard to write about 
visual things.


On 1/17/2014 9:33 AM, Stian Thorgersen wrote:
> Personally I hate screencast tutorials, but I can imagine lots of people like them.
>
> My issues with screencast is that they take a long time to watch, and in the end you have an idea on how to do it, but you don't have the specifics. You may then have to rewind the screencast to find a particular point.
>
> Documentation is much more straight to the point, and you can look up specific things you are wondering about directly and use it as a reference when you're trying to achieve something.
>
> ----- Original Message -----
>> From: "Gabriel Cardoso" <gcardoso at redhat.com>
>> To: keycloak-dev at lists.jboss.org
>> Sent: Thursday, 16 January, 2014 4:15:39 PM
>> Subject: Re: [keycloak-dev] minimum doc requirements?
>>
>> It would be good to provide a “Documentation” link inside the console that
>> leads to the list of tutorials.
>>
>> Gabriel
>>
>> On Jan 16, 2014, at 12:37 AM, Bill Burke < bburke at redhat.com > wrote:
>>
>>
>>
>> What do we minimally need for documentation for Alpha 1?
>>
>> * Install/Config Server
>> * Install/Config Adapters
>>
>> I'm thinking that screencast tutorials would be much better than
>> documentation. IMO, its hard to document UIs. Its better just seeing
>> them in action, so for Alpha 1 I'll just do these screencast tutorials:
>>
>> Tutorial #1:
>> * Create a realm through admin console for customer-portal demo
>> * Create roles, user, role mappings, scope mappings, applications etc.
>> * Obtain a keycloak.json file for the adapter configs.
>> * enable adapters for customer, product, and database portal.
>> Tutorial #2:
>> * Create an oauth-client
>> * configure third-party example and walk through it
>> * demo it.
>> Tutorial #3:
>> * Create a Google OAuth account
>> * Enable social login for demo
>> * Set up default roles
>> * Enable registration
>> Tutorial #4:
>> * Turning on TOTP.
>> * Managing users
>> Tutorial #5:
>> * Setting up SSL
>>
>> --
>> Bill Burke
>> JBoss, a division of Red Hat
>> http://bill.burkecentral.com
>> _______________________________________________
>> keycloak-dev mailing list
>> keycloak-dev at lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/keycloak-dev
>>
>> ---
>> Gabriel Cardoso
>> User Experience Designer @ Red Hat
>>
>>
>> _______________________________________________
>> keycloak-dev mailing list
>> keycloak-dev at lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/keycloak-dev
>
> _______________________________________________
> keycloak-dev mailing list
> keycloak-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/keycloak-dev
>

-- 
Bill Burke
JBoss, a division of Red Hat
http://bill.burkecentral.com