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

Note

From now on, this dashboard serves primarily to complete validation testing on content committed before the ForgeRock Dev Process made it clear that Dev/SME review happens before code is committed.

Review continues according to the workflow described on the ForgeRock Dev Process page. In a nutshell, log issues in JIRA for problems with the docs. Fixes for JIRA issues must be SME reviewed in Crucible before they are committed. Include both the issue number and the review number when committing fixes. Validators then start review after the JIRA issue is marked as Resolved: Fixed.

Review Dashboard

  • Reviewers, please send your review comments directly to the author. 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

Release Notes

What's New in OpenDJ

mark

1

 

ludo

TODO

matthew

TODO

gary

TODO

Release Notes

Before You Install

mark

1

 

ludo

TODO

matthew

TODO

gary

TODO

Release Notes

OpenDJ Compatibility

mark

1

 

ludo

TODO

Bruno Vernay

2011-11-30 09:43:32 -0500

gary

TODO

Release Notes

OpenDJ Fixes, Limitations, and Known Issues

mark

1

 

ludo

TODO

matthew

TODO

gary

TODO

Release Notes

How to Report Problems and Provide Feedback

mark

1

Y

ludo

TODO

matthew

TODO

gary

TODO

Release Notes

Support

mark

1

Y

ludo

TODO

matthew

TODO

gary

TODO

Installation Guide

Installing OpenDJ With the QuickSetup Wizard

mark

1

Y

ludo

TODO

Sachiko Wallace

Fri Oct 14 16:50:19 CEST 2011

gary

TODO

Installation Guide

Installing OpenDJ From the Command Line

mark

1

Y

ludo

TODO

matthew

TODO

gary

TODO

Installation Guide

Tuning JVM and Cache Options

mark

1

Y

ludo

TODO

matthew

TODO

gary

TODO

Installation Guide

Upgrading to OpenDJ

mark

1

 

ludo

TODO

matthew

TODO

gary

TODO

Installation Guide

Removing OpenDJ Servers

mark

1

Y

ludo

TODO

Sachiko Wallace

Fri Oct 14 16:50:19 CEST 2011

gary

TODO

Administration Guide

Administration Interfaces & Tools

mark

2

Y

ludo

TODO

Sachiko Wallace

Fri Nov  4 11:58:13 CET 2011

gary

TODO

Administration Guide

Managing Server Processes

mark

2

Y

ludo

TODO

Sachiko Wallace

Fri Nov  4 11:58:13 CET 2011

gary

TODO

Administration Guide

Importing & Exporting LDIF Data

mark

2

Y

ludo

TODO

Danny Turner

Thu Oct 13 18:11:12 CEST 2011

gary

TODO

Administration Guide

Configuring Servers For Client Application Access

mark

2

Y

ludo

TODO

Violette

Tue Feb  5 10:19:55 CET 2013

gary

TODO

Administration Guide

Configuring Privileges & Access Control

mark

2

Y

ludo

TODO

Violette

Tue Feb  5 10:19:55 CET 2013

gary

TODO

Administration Guide

Performing LDAP Operations

mark

2

Y

ludo

TODO

Sachiko Wallace

Fri Nov  4 11:58:13 CET 2011

gary

TODO

Administration Guide

Indexing Attribute Values

mark

2

Y

ludo

TODO

Danny Turner

Mon Oct 17 12:56:38 CEST 2011

gary

TODO

Administration Guide

Managing Data Replication

mark

2

Y

ludo

TODO

Danny Turner

Thu Oct 20 16:44:53 CEST 2011

gary

TODO

Administration Guide

Backing Up & Restoring Data

mark

2

Y

ludo

TODO

Violette

Tue Feb  5 10:19:55 CET 2013

gary

TODO

Administration Guide

Configuring Password Policy

mark

2

Y

ludo

TODO

Danny Turner

Wed Oct 19 11:38:43 CEST 2011

gary

TODO

Administration Guide

Implementing Account Lockout

mark

2

Y

ludo

TODO

Violette

Tue Feb  5 10:19:55 CET 2013

gary

TODO

Administration Guide

Setting Resource Limits

mark

2

Y

ludo

TODO

Sachiko Wallace

2011-11-23 16:08 +0100

gary

TODO

Administration Guide

Working With Groups of Entries

mark

2

Y

ludo

TODO

Violette

Tue Feb  5 10:19:55 CET 2013

gary

TODO

Administration Guide

Implementing Attribute Value Uniqueness

mark

2

Y

ludo

TODO

Danny Turner

Mon Oct 17 12:56:38 CEST 2011

gary

TODO

Administration Guide

Managing Schema

mark

2

Y

ludo

TODO

Violette

Tue Feb  5 10:19:55 CET 2013

gary

TODO

Administration Guide

Working With Referrals

mark

2

Y

ludo

TODO

Danny Turner

Mon Oct 17 12:56:38 CEST 2011

gary

TODO

Administration Guide

Working With Virtual and Collective Attributes

mark

2

Y

ludo

TODO

Violette

Tue Feb  5 10:19:55 CET 2013

gary

TODO

Administration Guide

Configuring Pass-Through Authentication

mark

1

Y

ludo

TODO

Sachiko Wallace

2011-11-23 16:08 +0100

gary

TODO

Administration Guide

Samba Password Synchronization

mark

1

Y

ludo

TODO

Nemanja

Done Sept. 28-29, 2011

gary

TODO

Administration Guide

Monitoring Servers

mark

2

Y

ludo

TODO

Violette

Tue Feb  5 10:19:55 CET 2013

gary

TODO

Administration Guide

Tuning Servers For Performance

mark

2

Y

ludo

TODO

Violette

Tue Feb  5 10:19:55 CET 2013

gary

TODO

Administration Guide

Moving Servers

mark

2

Y

ludo

TODO

Violette

Tue Feb  5 10:19:55 CET 2013

gary

TODO

Administration Guide

Troubleshooting Server Problems

mark

2

Y

ludo

TODO

Violette

Tue Feb  5 10:19:55 CET 2013

gary

TODO

Administration Guide

Tools Reference

mark

3

Y

ludo

TODO

Violette

Tue Feb  5 10:19:55 CET 2013

gary

TODO

Administration Guide

File layout

mark

3

Y

ludo

TODO

Violette

Tue Feb  5 10:19:55 CET 2013

gary

TODO

Administration Guide

Ports Used

mark

1

Y

ludo

TODO

Violette

Tue Feb  5 10:19:55 CET 2013

gary

TODO

Administration Guide

Standards, RFCs, & Internet-Drafts

mark

2

Y

ludo

TODO

Violette

Tue Feb  5 10:19:55 CET 2013

gary

TODO

Administration Guide

LDAP Controls

mark

2

Y

ludo

TODO

Violette

Tue Feb  5 10:19:55 CET 2013

gary

TODO

Administration Guide

LDAP Extended Operations

mark

2

Y

ludo

TODO

Violette

Tue Feb  5 10:19:55 CET 2013

gary

TODO

Administration Guide

Localization

mark

2

Y

ludo

TODO

Violette

Tue Feb  5 10:19:55 CET 2013

gary

TODO

Documentation Plan

These plans depend on the OpenDJ roadmap.

Objectives

  • Begin work on OpenDJ core documentation.
  • Cover as much of the software life cycle as possible for this release, building a foundation for subsequent 2.x updates.
  • Complete review for 90% of Release Notes, Installation Guide.
  • Complete section-level outlines for Administrator's Guide, Developer's Guide.
  • Include OpenDJ directory server draft chapters in Administrator's Guide.
  • Include getting started information for SDK, RESTful front end in Developer's Guide.
  • Implement build-time generation 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
  • Javadoc: OpenDJ SDK API Spec packaged alongside other core documentation
  • Configuration Reference: Best effort. HTML only for 2.5.

Schedule

See Review Dashboard above.

Assumptions

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

  • No labels