[#1129] Point the guides' Javadoc links at the published apidocs, and resolve {opendj-version} in the uninstall and monitoring pages - #1140
Open
vharseko wants to merge 1 commit into
Conversation
…blished apidocs, and resolve {opendj-version} in the uninstall and monitoring pages
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #1129
Problem
../javadoc/index.html(and../javadoc/index.html?org/…/X.html), which is 404 on the site: the Javadoc is published athttps://doc.openidentityplatform.org/opendj/apidocs/. That Javadoc is the frameless kind, so theindex.html?<class page>form would only open the overview there, not the class.{opendj-version}. Theasciidoc-pre-processgoal ofdoc-maven-plugin(AsciidocPreProcessMojo.updateVersionAttributes) resolves the version only by rewriting a:opendj-version: x.y.zline on the page itself.install-guide/chap-uninstall.adochas no such line, somsiexec /x opendj-{opendj-version}.msi /quietstays literal.admin-guide/chap-monitoring.adocdefines the attribute, but its OpenDMK console block (unzip opendj-{opendj-version}.zip) has nosubs="attributes", and a listing block does not substitute attributes by default.Change
server-dev-guide/chap-writing-plugins.adoc(4 links) andreference/appendix-interface-stability.adoc(1 link): point athttps://doc.openidentityplatform.org/opendj/apidocs/:index.htmlfor the API as a whole, and the class page itself forPluginType,DirectoryServerPluginandPasswordValidator. The links are absolute so that they also work in the PDF build.install-guide/chap-uninstall.adoc: define:opendj-version: x.y.z, which the pre-processor rewrites like on the other pages.admin-guide/chap-monitoring.adoc:subs="attributes"on the OpenDMK console block, as on the other blocks of that page that use the attribute.Verification
https://doc.openidentityplatform.org/opendj/javadoc/index.htmlanswers 404.:opendj-version:rewrite, onmasterand on this branch:master:{opendj-version}stays literal once inchap-uninstall.htmland once inchap-monitoring.html, and 5 hrefs point at../javadoc/….{opendj-version}is left (msiexec /x opendj-5.1.1.msi /quiet,unzip opendj-5.1.1.zip), and all 5 hrefs point at…/opendj/apidocs/…..adocunderopendj-doc-generated-ref/src/main/asciidocfinds no other page that uses{opendj-version}/{opendj-version-short}without defining it, and no other listing block that uses them withoutsubs.No test is added: the change is documentation only.