You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@james.apache.org by rc...@apache.org on 2023/03/22 02:52:34 UTC
[james-project] 03/03: [CLEAN CODE] AsciiDoc update xref link
This is an automated email from the ASF dual-hosted git repository.
rcordier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git
commit 29d7bd868a53845cebd4c999e598b9ce5587ef4c
Author: Tung Van TRAN <vt...@linagora.com>
AuthorDate: Tue Mar 21 16:34:04 2023 +0700
[CLEAN CODE] AsciiDoc update xref link
---
docs/modules/concepts/nav.adoc | 6 +++---
docs/modules/concepts/pages/user/index.adoc | 15 +++++++--------
.../docs/modules/ROOT/pages/configure/opensearch.adoc | 2 +-
.../docs/modules/ROOT/pages/operate/guide.adoc | 6 +++---
.../docs/modules/ROOT/pages/operate/migrating.adoc | 2 +-
.../docs/modules/ROOT/pages/operate/webadmin.adoc | 16 ++++++++--------
.../docs/ui-overrides/partials/header-content.hbs | 2 +-
7 files changed, 24 insertions(+), 25 deletions(-)
diff --git a/docs/modules/concepts/nav.adoc b/docs/modules/concepts/nav.adoc
index aad0052c65..997a351b49 100644
--- a/docs/modules/concepts/nav.adoc
+++ b/docs/modules/concepts/nav.adoc
@@ -1,9 +1,9 @@
* xref:index.adoc[]
** xref:user/index.adoc[]
** xref:mail/index.adoc[]
-*** xref:mail/messages/index.adoc[]
-**** xref:mail/messages/imf.adoc[]
-**** xref:mail/messages/mime.adoc[]
+*** xref:messages/index.adoc[]
+**** xref:messages/imf.adoc[]
+**** xref:messages/mime.adoc[]
** xref:protocols/index.adoc[]
*** xref:protocols/smtp.adoc[]
*** xref:protocols/pop.adoc[]
diff --git a/docs/modules/concepts/pages/user/index.adoc b/docs/modules/concepts/pages/user/index.adoc
index e8939c6d7a..a88875ce66 100644
--- a/docs/modules/concepts/pages/user/index.adoc
+++ b/docs/modules/concepts/pages/user/index.adoc
@@ -2,8 +2,8 @@
:navtitle: User Model
-For clarity, we have defined various roles for actors who interact
-with xref:servers/index.adoc[James servers] in one way or another.
+For clarity, we have defined various roles for actors who interact
+with xref:servers:index.adoc[James servers] in one way or another.
The deliverables we make available are produced with these roles in mind.
Note that any given person may play more than one role, even at the same
time.
@@ -21,10 +21,10 @@ time.
A **User** simply uses email without any notion of what server is providing the service.
More precisely, in typical cases a User will have an email client for reading and writing email. The
-xref:glossary.adoc[email client] will connect to the James server via
-xref:mail/protocols/smtp.adoc[SMTP],
-xref:mail/protocols/pop.adoc[POP], or
-xref:mail/protocols/imap.adoc[IMAP].
+xref:glossary.adoc[email client] will connect to the James server via
+xref:protocols/smtp.adoc[SMTP],
+xref:protocols/pop.adoc[POP], or
+xref:protocols/imap.adoc[IMAP].
The User will have no indication anywhere that the server is a James server.
@@ -36,8 +36,7 @@ The Operator does not compile any Java code, and does not require any software
development environment.
Apache James offers Operators a range of servers for various use cases, including:
-
- * A xref:server/basic/index.adoc[Basic Server] ideal for busy Operators who
+ * A xref:servers:basic/index.adoc[Basic Server] ideal for busy Operators who
are interested in an easy-to-use self-hosting solution, but who may not have the
time to gain deep expertise
* An xref:server/advanced/index.adoc[Advanced Server] well-suited for Operators with
diff --git a/server/apps/distributed-app/docs/modules/ROOT/pages/configure/opensearch.adoc b/server/apps/distributed-app/docs/modules/ROOT/pages/configure/opensearch.adoc
index 5ee6dec4f3..80ddd1260e 100644
--- a/server/apps/distributed-app/docs/modules/ROOT/pages/configure/opensearch.adoc
+++ b/server/apps/distributed-app/docs/modules/ROOT/pages/configure/opensearch.adoc
@@ -116,7 +116,7 @@ This is controlled in the `search.properties` file via the `implementation` prop
to `OpenSearch`). Setting this configuration parameter to `scanning` will effectively disable OpenSearch, no
further indexation will be done however searches will rely on the scrolling search, leading to expensive and longer
searches. Disabling OpenSearch requires no extra action, however
-xref:operate/webadmin.adoc#reindexing_all_mails[a full re-indexing]needs to be carried out when enabling OpenSearch.
+xref:operate/webadmin.adoc#_reindexing_all_mails[a full re-indexing]needs to be carried out when enabling OpenSearch.
== SSL Trusting Configuration
diff --git a/server/apps/distributed-app/docs/modules/ROOT/pages/operate/guide.adoc b/server/apps/distributed-app/docs/modules/ROOT/pages/operate/guide.adoc
index c39a3ecf85..729f68c872 100644
--- a/server/apps/distributed-app/docs/modules/ROOT/pages/operate/guide.adoc
+++ b/server/apps/distributed-app/docs/modules/ROOT/pages/operate/guide.adoc
@@ -64,7 +64,7 @@ to emails being stored in `cassandra://var/mail/rrt-error/`.
We recommend monitoring the content of this mail repository to be empty.
If it is not empty, we recommend
-verifying user mappings via xref:operate/webadmin.adoc#_user_mappings[User Mappings webadmin API] then once identified break the loop by removing
+verifying user mappings via xref:operate/webadmin.adoc#_listing_user_mappings_[User Mappings webadmin API] then once identified break the loop by removing
some Recipient Rewrite Table entry via the
xref:operate/webadmin.adoc#_removing_an_alias_of_an_user[Delete Alias],
xref:operate/webadmin.adoc#_removing_a_group_member[Delete Group member],
@@ -428,7 +428,7 @@ http://cassandra.apache.org/doc/3.11.11/cql/security.html[cassandra documentatio
Except for the case above, the permissions are not auto available for a
specific role unless they are granted by `GRANT` command. Therefore, if
you didn’t provide more permissions than
-link:#Grant_permissions_on_created_keyspace_to_the_role[granting
+link:#_grant_permissions_on_created_keyspace_to_the_role[granting
section], there’s no need to revoke.
== Cassandra table level configuration
@@ -602,7 +602,7 @@ by default if not defined).
=== Restore deleted messages after deletion
After users deleted their mails and emptied the trash, the admin can use
-xref:operate/webadmin.adoc#_restore_deleted_messagest[Restore Deleted Messages]
+xref:operate/webadmin.adoc#_restore_deleted_messages[Restore Deleted Messages]
to restore all the deleted mails.
=== Cleaning expired deleted messages
diff --git a/server/apps/distributed-app/docs/modules/ROOT/pages/operate/migrating.adoc b/server/apps/distributed-app/docs/modules/ROOT/pages/operate/migrating.adoc
index 0726d2ace4..f10d506714 100644
--- a/server/apps/distributed-app/docs/modules/ROOT/pages/operate/migrating.adoc
+++ b/server/apps/distributed-app/docs/modules/ROOT/pages/operate/migrating.adoc
@@ -15,7 +15,7 @@ can be performed via WebAdmin or the CLI.
** Read xref:operate/webadmin.adoc#_create_a_user[this section] for creating users
* Using the CLI :
** Read xref:operate/cli.adoc#_manage_domains[this section] for creating domains
- ** Read xref:operate/cli.adoc#_manage_users[this section] for creating users
+ ** Read xref:operate/cli.adoc#_managing_users[this section] for creating users
Second, you want to allow an administrator account of your Distributed Server to have write access on other user mailboxes.
This can be setted up this the *administratorId* configuration option of the xref:configure/usersrepository.adoc[usersrepository.xml] configuration file.
diff --git a/server/apps/distributed-app/docs/modules/ROOT/pages/operate/webadmin.adoc b/server/apps/distributed-app/docs/modules/ROOT/pages/operate/webadmin.adoc
index 439515bd30..ad8936c269 100644
--- a/server/apps/distributed-app/docs/modules/ROOT/pages/operate/webadmin.adoc
+++ b/server/apps/distributed-app/docs/modules/ROOT/pages/operate/webadmin.adoc
@@ -906,7 +906,7 @@ The scheduled task will have the following type
....
Note that conflicting entry inconsistencies will not be fixed and will
-require to explicitly use link:#correcting-ghost-mailbox[ghost mailbox]
+require to explicitly use link:#_correcting_ghost_mailbox[ghost mailbox]
endpoint in order to merge the conflicting mailboxes and prevent any
message loss.
@@ -951,7 +951,7 @@ The scheduled task will have the following type
....
Note that conflicting inconsistencies entries will not be fixed and will
-require to explicitly use link:#correcting-ghost-mailbox[ghost mailbox]
+require to explicitly use link:#_correcting_ghost_mailbox[ghost mailbox]
endpoint in order to merge the conflicting mailboxes and prevent any
message loss.
@@ -2115,7 +2115,7 @@ to be returned.
Please note that users are alphabetically ordered on username.
The response is a list of usernames, with attached quota details as
-defined link:#getting-the-quota-for-a-user[here].
+defined link:#_getting_the_quota_for_a_user[here].
Response codes:
@@ -4136,12 +4136,12 @@ backend.
Note that currently the progress can be tracked by logs.
-* link:#Retrieving_current_Cassandra_schema_version[Retrieving current
+* link:#_retrieving_current_cassandra_schema_version_[Retrieving current
Cassandra schema version]
-* link:#Retrieving_latest_available_Cassandra_schema_version[Retrieving
+* link:#_retrieving_latest_available_cassandra_schema_version_[Retrieving
latest available Cassandra schema version]
-* link:#Upgrading_to_a_specific_version[Upgrading to a specific version]
-* link:#Upgrading_to_the_latest_version[Upgrading to the latest version]
+* link:#_upgrading_to_a_specific_version_[Upgrading to a specific version]
+* link:#_upgrading_to_the_latest_version_[Upgrading to the latest version]
==== Retrieving current Cassandra schema version
@@ -4481,7 +4481,7 @@ BODY: is the json query has the same structure with Restore Deleted Messages sec
....
*Note*: Json query passing into the body follows the same rules &
-restrictions like in link:#Restore_deleted_messages[Restore Deleted
+restrictions like in link:#_restore_deleted_messages[Restore Deleted
Messages]
Response code:
diff --git a/server/apps/distributed-app/docs/ui-overrides/partials/header-content.hbs b/server/apps/distributed-app/docs/ui-overrides/partials/header-content.hbs
index caa1c0baaa..68461dded7 100644
--- a/server/apps/distributed-app/docs/ui-overrides/partials/header-content.hbs
+++ b/server/apps/distributed-app/docs/ui-overrides/partials/header-content.hbs
@@ -29,7 +29,7 @@
<a class="navbar-link" href="#">Community</a>
<div class="navbar-dropdown">
<!-- Not ideal but dropping the version in the href requires tweaking james-projet docs module first -->
- <a class="navbar-item" href="/james-project/3.6.0/community/mailing-lists.html">Mailing lists</a>
+ <a class="navbar-item" href="/james-project/3.7.3/community/mailing-lists.html">Mailing lists</a>
<a class="navbar-item" href="https://gitter.im/apache/james-project"><svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 32 32" class="logo-gitter-sign" data-v-44ebcb1a=""><rect x="15" y="5" width="2" height="10"></rect> <rect x="10" y="5" width="2" height="20"></rect> <rect x="5" y="5" width="2" height="20"></rect> <rect width="2" height="15"></rect></svg> Gitter</a>
<a class="navbar-item" href="https://twitter.com/ApacheJames">
<span class="icon">
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org