Child pages
  • OpenDJ 3.0.0 Documentation Review Dashboard
Skip to end of metadata
Go to start of metadata

At this time, only the Developer Guide is written to target 3.0.0.

Review Dashboard

  • Reviewers, please send your review comments directly to the author, or log a bug. When the review comments have been handled to your satisfaction, change the dashboard, replacing "TODO" in the sign off date with current date. (Need more instructions? See Documentation Review Process.)
  • Draft Ready? == "Y" means the draft content has been published for review to start.
  • Authors and reviewers are identified in the following table. You are welcome to participate, too. Let us know how you plan to get involved on the opendj-dev list.

Book

Chunk/Browse Source

Author

Priority

Draft Ready?

Design Reviewer

Design Sign Off Date

SME Reviewer

SME Sign Off Date

Validation Tester

Validation Sign Off Date

Developer Guide

Understanding LDAP

Mark

2

Y

Ludo

TODO

Violette

Mon, 03 Sep 2012

TBD

TODO

Developer Guide

Best Practices For LDAP Application Developers

Mark

2

Y

Ludo

TODO

Violette

Mon, 03 Sep 2012

TBD

TODO

Developer Guide

Getting OpenDJ LDAP SDK

Mark

2

Y

Ludo

TODO

Violette

Mon, 03 Sep 2012

TBD

TODO

Developer Guide

Using the LDAP SDK

Mark

2

Section 4.3 is pending OPENDJ-178.

Ludo

TODO

TBD

TODO

TBD

TODO

Developer Guide

Authenticating To the Directory

Mark

2

Y

Ludo

TODO

Violette

Mon, 03 Sep 2012

TBD

TODO

Developer Guide

Searching & Comparing Directory Data

Mark

2

Y

Ludo

TODO

Violette

Mon, 03 Sep 2012

TBD

TODO

Developer Guide

Getting Information About the Directory Service

Mark

2

Y

Ludo

TODO

Violette

Mon, 03 Sep 2012

TBD

TODO

Developer Guide

Updating Directory Data

Mark

2

Y

Ludo

TODO

Violette

Mon, 03 Sep 2012

TBD

TODO

Developer Guide

Working With LDIF

Mark

2

Y

Ludo

TODO

Violette

Mon, 03 Sep 2012

TBD

TODO

Developer Guide

Working With Controls

Mark

2

Y

Ludo

TODO

Violette

Mon, 03 Sep 2012

TBD

TODO

Developer Guide

Working With Extended Operations

Mark

2

Y

Ludo

TODO

Violette

Mon, 03 Sep 2012

TBD

TODO

Developer Guide

Internationalizing Applications

Mark

2

Y

Ludo

TODO

Violette

Mon, 03 Sep 2012

TBD

TODO

Developer Guide

Writing a Simple LDAP Proxy

Mark

2

Y

Ludo

TODO

Violette

Mon, 03 Sep 2012

TBD

TODO

Developer Guide

Tools Reference

Mark

2

Y, pending OPENDJ-581.

Ludo

TODO

Violette

Mon, 03 Sep 2012

TBD

TODO

Documentation Plan

These plans depend on the OpenDJ roadmap.

Objectives

  • Technically accurate and complete documentation for OpenDJ 3.0.0.
  • Complete review for 90% of all core documentation.

Deliverables

  • Release Notes: What's new, known issues, fixed issues, limitations, supported platforms, pre-requisites
  • Installation Guide: Installation, initial configuration, upgrade, rollback, software removal
  • Administrator's Guide: Administration interfaces and tools, server process management, LDAP (LDAPS, DSML, RESTful) access, privileges, access control and effective rights, schema management, import/export, backup/restore, LDAP operations, indexing, logging and monitoring, virtual attributes, collective attributes, groups and referential integrity, password policy, referrals, resource limits, pass-through authentication, replication, account lockout, attribute uniqueness, server tuning, moving servers, troubleshooting. Appendices: file layout, ports used, supported standards, supported controls, supported extended operations, directory data localization support
  • Developer's Guide: LDAP model, best practices, introduction to SDK, examples of LDAP operations, use of controls, use of extended operations, working with LDIF, connection management, load balancing, failover management, synchronous versus asynchronous client applications. The LDAP SDK part of the Developer Guide might end up inside the Javadoc to make it easier for SDK developers to access inside their IDEs.
  • Javadoc: OpenDJ SDK API Spec packaged alongside other core documentation
  • Configuration Reference: Best effort. See also https://bugster.forgerock.org/jira/browse/OPENDJ-386.

Schedule

See Review Dashboard above.

Assumptions

No major changes to software roadmap before 3.0.0 without adjusting the plan.

  • No labels