From d3d791394b1224256c4fd4423dbf5ff89f9fbc15 Mon Sep 17 00:00:00 2001
From: Maxim Thomas <maxim.thomas@gmail.com>
Date: Thu, 03 Oct 2024 06:57:56 +0000
Subject: [PATCH] minor docs glitches fix (#420)
---
opendj-doc-generated-ref/src/main/asciidoc/reference/appendix-ports-used.adoc | 1 -
opendj-doc-generated-ref/src/main/asciidoc/reference/appendix-standards.adoc | 1 -
opendj-doc-generated-ref/src/main/asciidoc/install-guide/chap-install.adoc | 1 -
opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-server-process.adoc | 5 +++--
opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-privileges-acis.adoc | 2 +-
.github/workflows/release.yml | 5 +++--
opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-replication.adoc | 5 +++--
7 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 4649beb..2eb1b62 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -103,8 +103,9 @@
GITHUB_TOKEN: ${{ github.token }}
run: |
cd ${{ github.event.repository.name }}.wiki
- rm -rf docbkx
- cp -R ../opendj-doc-generated-ref/target/docbkx ../${{ github.event.repository.name }}.wiki
+ rm -rf asciidoc
+ mkdir asciidoc
+ cp -R ../opendj-doc-generated-ref/target/asciidoc/pdf ../${{ github.event.repository.name }}.wiki/asciidoc
git add -A
git commit -a -m "upload docs after release ${{ github.event.inputs.releaseVersion }}"
git tag -f ${{ github.event.inputs.releaseVersion }}
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-privileges-acis.adoc b/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-privileges-acis.adoc
index b7d5662..d465d0b 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-privileges-acis.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-privileges-acis.adoc
@@ -298,7 +298,7 @@
+
The optional inheritance specification, `parent[child-level].`, lets you specify how many levels below the target entry inherit the ACI. Here __child-level__ is a number from 0 to 9, with 0 indicating the target entry only. Separate multiple __child-level__ digits with commas (,).
-`userdn [!]= "ldap-url++[|| ldap-url++ …]"`::
+`userdn [!]= "ldap-url{plus}{plus}[|| ldap-url{plus}{plus} …]"`::
To match the bind DN, replace __ldap-url++__ with either a valid LDAP URL such as `ldap:///uid=bjensen,ou=People,dc=example,dc=com`, `ldap:///dc=example,dc=com??sub?(uid=bjensen)`, or a special LDAP URL-like keyword from the following list:
+
[open]
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-replication.adoc b/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-replication.adoc
index ca171da..6e5a78c 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-replication.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-replication.adoc
@@ -1069,11 +1069,12 @@
. Make sure you have already set up at least a couple of OpenDJ servers that replicate user data.
+
This example starts with the following multi-role servers:
-
++
+--
* `/path/to/dsrs1` (ports: 1389, 1636, 4444, 8989; replicating user data for `dc=example,dc=com`)
* `/path/to/dsrs2` (ports: 2389, 2636, 5444, 9989; replicating user data for `dc=example,dc=com`)
-
+--
+
`/path/to/dsrs1` is the target server to be broken into standalone components.
+
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-server-process.adoc b/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-server-process.adoc
index ae3b59e..ac40e0b 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-server-process.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-server-process.adoc
@@ -185,10 +185,11 @@
----
+
+--
__Do not intentionally kill the OpenDJ server process__ unless the server is completely unresponsive.
-+
-When stopping cleanly, the server writes state information to database backends, and releases locks that it holds on database files.
+When stopping cleanly, the server writes state information to database backends, and releases locks that it holds on database files.
+--
====
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/install-guide/chap-install.adoc b/opendj-doc-generated-ref/src/main/asciidoc/install-guide/chap-install.adoc
index 282cda2..0acb05f 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/install-guide/chap-install.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/install-guide/chap-install.adoc
@@ -988,7 +988,6 @@
* `authentication`: Set to the correct simple bind credentials.
+
The LDAP account used to authenticate needs to perform proxied authorization as described in xref:../server-dev-guide/chap-ldap-operations.adoc#proxied-authz["Configuring Proxied Authorization"] in the __Directory Server Developer's Guide__.
-
+
The default sample configuration configuration is built to work with generated example data and also the sample content in link:../attachments/Example.ldif[Example.ldif, window=\_blank]. If your data is different, then you must also change the JSON resource to LDAP entry mapping settings, described in xref:../reference/appendix-rest2ldap.adoc#mappings-json["Mapping Configuration File"] in the __Reference__.
+
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/reference/appendix-ports-used.adoc b/opendj-doc-generated-ref/src/main/asciidoc/reference/appendix-ports-used.adoc
index fdc9462..1ed5777 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/reference/appendix-ports-used.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/reference/appendix-ports-used.adoc
@@ -45,7 +45,6 @@
[#snmp-port]
SNMP: 161, 162::
+
-+
OpenDJ directory server listens for SNMP traffic on port 161 by default, and uses port 162 for traps. SNMP is not enabled by default.
[#jmx-port]
diff --git a/opendj-doc-generated-ref/src/main/asciidoc/reference/appendix-standards.adoc b/opendj-doc-generated-ref/src/main/asciidoc/reference/appendix-standards.adoc
index a8cb3fd..5d3707f 100644
--- a/opendj-doc-generated-ref/src/main/asciidoc/reference/appendix-standards.adoc
+++ b/opendj-doc-generated-ref/src/main/asciidoc/reference/appendix-standards.adoc
@@ -159,7 +159,6 @@
[#rfc2849]
link:http://tools.ietf.org/html/rfc2849[RFC 2849: The LDAP Data Interchange Format (LDIF) - Technical Specification, window=\_top]::
+
-+
Describes a file format suitable for describing directory information or modifications made to directory information.
[#rfc2891]
--
Gitblit v1.10.0