Around the time OpenIG 3.0.0 released back in August, we decided that the introductory part of the main guide left much up to the reader. Indeed, it introduced all the concepts, but you had to play with OpenIG for a while until those concepts would sink in.
For those of you trying the nightly builds, notice that since then the aim has been to simplify the draft of the next Guide to OpenIG. Thanks to Christophe, Guillaume, Jean-Charles, Ludo, Matt, Simon, Violette, Warren, and all of you who have offered your suggestions and pointed out parts that needed attention.
Now the guide starts with a short chapter on Understanding OpenIG. That chapter covers the main concepts that help you get started: the Exchange that encapsulates the HTTP request and the response as well as state information, the configuration including routes, how Filters and Handlers are chained together and how the Exchange flows through a chain.
The rest of the guide aims to be hands-on & practical. From the Getting Started chapter that should have you protecting your first app in a few minutes, through Installation in Detail and a series of tutorial chapters and configuration templates, to scripting and troubleshooting, you pick up the ideas a few at a time while seeing OpenIG in action.
Once you feel pretty confident that you understand how OpenIG works, to get all the details or to find just the right tool for a particular job you can check out the draft Reference.
Please feel welcome to log issues against these and all of the docs that we are working on.
When your web search turns up hits for ForgeRock documentation, often the in-progress, draft docs top the list. Although this is handy for those of us working with nightly builds from trunk, it’s not so great if you’re working with a stable release, one that does not yet include the newest features and the latest compatibility changes. The finished docs have been more thoroughly reviewed and finished than the in-progress, draft docs, and aim to be technically accurate and complete with respect to the software as delivered.
With the move to the 2.1.4 release of the documentation tools, we have started publishing the in-progress, draft project documentation with headers and meta tags to encourage robots not to index those versions. Then hope is that, over time, readers will find it easier to find the published docs at http://docs.forgerock.org/ that match the release they use.
If you are working with nightly builds and trying out the latest features, know that we are still keeping the draft docs as current as possible. Please do continue using the draft docs. Feel free to log issues. Feel free to link to them from blog posts about new features and so forth. When answering questions from someone using a stable release, however, do send them to the published docs for the release at http://docs.forgerock.org/.
ForgeRock doc tools 2.1.4 is now available. This is a maintenance release, primarily to integrate an options for OpenICF docs. See the release notes for details.
No configuration changes are required to move to this version, except to update the version number in your POM. See the README for more about how to use the doc tools.
Welcome to Chris Lee! Chris joined the ForgeRock documentation team today. Great to have you at ForgeRock, Chris!
Chris comes to us from SN Systems (part of Sony Computer Entertainment Group) where he led the documentation effort for their PlayStation game development tools. He understands what developers are looking for, and is primed to come over to the world of Java and the web. Chris’s previous experience in support and as a website engineer give him a head start understanding the solution space that we address at ForgeRock. And he brings a Microsoft power user’s perspective to our team, which is important for a lot of our readers.
Chris will focus on ForgeRock access management documentation, in particular for OpenAM. This is good news for the ForgeRock access management community.
In case you missed the Ignite talks at OSCON 2014, Mike Jang presented what it’s like for a tech writer to take over the role of sys admin.
Excellent talk, Mike! Short, sweet, and had me smiling the whole time.
(Somehow we need to work Edvard Munch into the admonition graphics, too.)
Welcome to David Goldsmith who joins the ForgeRock documentation team today. Delighted that you have come to work with us at ForgeRock, David!
If you got identity and access management software training before ForgeRock, David’s name might already be familiar to you. David goes way back with identity management, having designed, developed and delivered training for identity management product lines at Sun Microsystems and at Oracle. He comes to ForgeRock from Cloudera, where he also got to know Hadoop very well. As a hands-on, technical curriculum developer, David has strong experience getting his ideas across in the classroom, in training labs, and in writing.
A while ago I wrote, “We aspire … to share understanding with developers and partners like you.” David can definitely deliver on that aspiration. His work promises to be a big win for the community.
ForgeRock doc tools 2.1.3 is now available.
This is a minor maintenance release, mainly of the default branding.
As mentioned in the release notes, this release brings one improvement and two bug fixes:
- DOCS-72: Improve widow and orphan control in PDF
You can now use the processing instruction
<?hard-pagebreak?> between block elements to force an unconditional page break in PDF (and RTF) output. The processing instruction has no effect on HTML output.
- DOCS-162: <replaceable> tags within <screen> tags have no effect in the HTML
The <replaceable> text now shows up in bold+italic font.
- DOCS-173: Link text too dark in top-right banner showing latest release
No configuration changes are required, except to update the version number in your POM. See the README for more about how to use the doc tools.
Thanks to Gene Hirayama and Laszlo Hordos for their contributions, and to Lana Frost for testing. ForgeRock doc tools 2.1.2 is now available.
This is a maintenance release of the Maven doc build plugin, the default branding, and the common content. No configuration changes are required, except to update the version number in your POM. In order to benefit from improvements to the PDF cover pages, however, you will want to add logos and update the authors list to include a corporate author.
For details about fixes, enhancements, and known issues in the doc tools, see the release notes.