Uploaded image for project: 'OpenDJ'
  1. OpenDJ
  2. OPENDJ-987

Determine what to do with links to http://opendj.forgerock.org/

    Details

    • Type: Task
    • Status: Done
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 2.6.0
    • Fix Version/s: 2.6.0
    • Component/s: documentation
    • Labels:
      None

      Description

      When we publish docs, we should limit the links to resources that can continue to evolve after publication.

      That is not to say that we must eliminate all links to resources that can change, but instead that we should prefer (relative) links.

      For example, a link to http://opendj.forgerock.org/opendj-server/configref/ could be http://docs.forgerock.org/en/opendj/2.6.0/configref/ instead when the final docs are published for 2.6.0.

      There are many candidates.

      $ find . -name "*xml" -exec grep -l "http://opendj.forgerock.org/" {} \;
      ./admin-guide/chap-admin-tools.xml
      ./admin-guide/chap-groups.xml
      ./admin-guide/chap-ldap-operations.xml
      ./admin-guide/chap-listeners.xml
      ./admin-guide/chap-pwd-policy.xml
      ./admin-guide/chap-rest-operations.xml
      ./admin-guide/chap-server-process.xml
      ./admin-guide/chap-virtual-attrs-collective-attrs.xml
      ./dev-guide/chap-authenticating.xml
      ./dev-guide/chap-controls.xml
      ./dev-guide/chap-extended-ops.xml
      ./dev-guide/chap-get-sdk.xml
      ./dev-guide/chap-getting-directory-info.xml
      ./dev-guide/chap-reading.xml
      ./dev-guide/chap-simple-proxy.xml
      ./dev-guide/chap-using-the-sdk.xml
      ./dev-guide/chap-writing.xml
      ./install-guide/chap-install-cli.xml
      ./shared/man-dsconfig.xml
      

      Most of the links point to resources, such as Example.ldif or to LDAP SDK examples, that are not likely to be published with the 2.6.0 docs.

        Attachments

          Activity

            People

            • Assignee:
              Mark Mark Craig
              Reporter:
              Mark Mark Craig
              Dev Assignee:
              Mark Craig
              QA Assignee:
              Christophe Sovant
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: