This is an automated email from the ASF dual-hosted git repository.
ilgrosso pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/syncope.git
The following commit(s) were added to refs/heads/master by this push:
new be70cca717 Fixing cross-references between Getting Started and
Reference guides
be70cca717 is described below
commit be70cca7179b494faab8d398d621abbb351abd21
Author: Francesco Chicchiriccò <[email protected]>
AuthorDate: Fri Jan 31 07:09:26 2025 +0100
Fixing cross-references between Getting Started and Reference guides
---
src/main/asciidoc/getting-started/movingForward.adoc | 4 ++--
src/main/asciidoc/getting-started/obtain.adoc | 8 ++++----
src/main/asciidoc/reference-guide/usage/clientlibrary.adoc | 10 +++++-----
src/main/asciidoc/reference-guide/usage/customization.adoc | 4 ++--
src/main/asciidoc/reference-guide/usage/usage.adoc | 4 ++--
5 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/src/main/asciidoc/getting-started/movingForward.adoc
b/src/main/asciidoc/getting-started/movingForward.adoc
index d22fca9a3f..0c5a441710 100644
--- a/src/main/asciidoc/getting-started/movingForward.adoc
+++ b/src/main/asciidoc/getting-started/movingForward.adoc
@@ -22,10 +22,10 @@
Once you have obtained a working installation of Apache Syncope using one of
the methods reported above, you should consider
reading the
ifeval::["{backend}" == "html5"]
-https://syncope.apache.org/docs/reference-guide.html[Apache Syncope Reference
Guide.]
+https://syncope.apache.org/docs/4.0/reference-guide.html[Apache Syncope
Reference Guide.]
endif::[]
ifeval::["{backend}" == "pdf"]
-https://syncope.apache.org/docs/reference-guide.pdf[Apache Syncope Reference
Guide.]
+https://syncope.apache.org/docs/4.0/reference-guide.pdf[Apache Syncope
Reference Guide.]
endif::[]
to understand how to configure, extend, customize and deploy your new Apache
Syncope project.
diff --git a/src/main/asciidoc/getting-started/obtain.adoc
b/src/main/asciidoc/getting-started/obtain.adoc
index 7910672443..4f742f0c8a 100644
--- a/src/main/asciidoc/getting-started/obtain.adoc
+++ b/src/main/asciidoc/getting-started/obtain.adoc
@@ -564,10 +564,10 @@ If no failures are encountered, your basic Apache Syncope
project is now ready t
Before actual deployment as executable or onto a Jakarta EE container, you
need to further check the **Customization**
chapter of the
ifeval::["{backend}" == "html5"]
-https://syncope.apache.org/docs/reference-guide.html[Apache Syncope Reference
Guide.]
+https://syncope.apache.org/docs/4.0/reference-guide.html[Apache Syncope
Reference Guide.]
endif::[]
ifeval::["{backend}" == "pdf"]
-https://syncope.apache.org/docs/reference-guide.pdf[Apache Syncope Reference
Guide.]
+https://syncope.apache.org/docs/4.0/reference-guide.pdf[Apache Syncope
Reference Guide.]
endif::[]
====
@@ -595,10 +595,10 @@ configured for the embedded mode.
When building for production, instead, it is recommended to check the
**Customization** chapter of
the
ifeval::["{backend}" == "html5"]
-https://syncope.apache.org/docs/reference-guide.html[Apache Syncope Reference
Guide.]
+https://syncope.apache.org/docs/4.0/reference-guide.html[Apache Syncope
Reference Guide.]
endif::[]
ifeval::["{backend}" == "pdf"]
-https://syncope.apache.org/docs/reference-guide.pdf[Apache Syncope Reference
Guide.]
+https://syncope.apache.org/docs/4.0/reference-guide.pdf[Apache Syncope
Reference Guide.]
endif::[]
====
diff --git a/src/main/asciidoc/reference-guide/usage/clientlibrary.adoc
b/src/main/asciidoc/reference-guide/usage/clientlibrary.adoc
index 0a8629f5e1..012830250a 100644
--- a/src/main/asciidoc/reference-guide/usage/clientlibrary.adoc
+++ b/src/main/asciidoc/reference-guide/usage/clientlibrary.adoc
@@ -69,7 +69,7 @@ than JSON (default), to select
https://en.wikipedia.org/wiki/HTTP_compression[HTTP compression^] or to set the
https://cxf.apache.org/javadoc/latest/org/apache/cxf/configuration/jsse/TLSClientParameters.html[TLS
client configuration^]
(more options in the
-https://syncope.apache.org/apidocs/3.0/org/apache/syncope/client/lib/SyncopeClientFactoryBean.html[Javadoc^]):
+https://syncope.apache.org/apidocs/4.0/org/apache/syncope/client/lib/SyncopeClientFactoryBean.html[Javadoc^]):
[source,java]
----
@@ -102,7 +102,7 @@ SyncopeClient client = new SyncopeClientFactoryBean().
===== Examples
Select one of the
-https://syncope.apache.org/apidocs/3.0/org/apache/syncope/common/rest/api/service/package-summary.html[RESTful
services^]
+https://syncope.apache.org/apidocs/4.0/org/apache/syncope/common/rest/api/service/package-summary.html[RESTful
services^]
and invoke one of the available methods:
[source,java]
@@ -117,13 +117,13 @@ loggerService.update(LoggerType.LOG, loggerTO);
[TIP]
Advanced REST features are also available from `SyncopeClient` instances: check
-https://syncope.apache.org/apidocs/3.0/org/apache/syncope/client/lib/SyncopeClient.html[the
javadoc^]
+https://syncope.apache.org/apidocs/4.0/org/apache/syncope/client/lib/SyncopeClient.html[the
javadoc^]
for more information.
.Search for Users, Groups or Any Objects
====
All search operations return
-https://syncope.apache.org/apidocs/3.0/org/apache/syncope/common/lib/to/PagedResult.html[paged
result handlers^]
+https://syncope.apache.org/apidocs/4.0/org/apache/syncope/common/lib/to/PagedResult.html[paged
result handlers^]
which can be exploited both for getting the actual results and for
extrapolating pagination coordinates.
[source,java]
@@ -211,7 +211,7 @@ UserTO userTO = self.getRight(); // <1>
Map<String, Set<String>> realm2entitlements = self.getLeft(); // <2>
List<String> delegations = self.getMiddle(); // <3>
----
-<1>
https://syncope.apache.org/apidocs/3.0/org/apache/syncope/common/lib/to/UserTO.html[UserTO^]
of the requesting user
+<1>
https://syncope.apache.org/apidocs/4.0/org/apache/syncope/common/lib/to/UserTO.html[UserTO^]
of the requesting user
<2> for each <<realms,realm>>, the owned <<entitlements,entitlements>>
<3> <<delegation,delegations>> assigned to the requesting user
====
diff --git a/src/main/asciidoc/reference-guide/usage/customization.adoc
b/src/main/asciidoc/reference-guide/usage/customization.adoc
index 611f5a7c77..97ee5ed005 100644
--- a/src/main/asciidoc/reference-guide/usage/customization.adoc
+++ b/src/main/asciidoc/reference-guide/usage/customization.adoc
@@ -30,10 +30,10 @@ adding new features or replacing existing components.
In general, the Embedded Mode (see the
ifeval::["{backend}" == "html5"]
-https://syncope.apache.org/docs/getting-started.html[Apache Syncope Getting
Started Guide]
+https://syncope.apache.org/docs/4.0/getting-started.html[Apache Syncope
Getting Started Guide]
endif::[]
ifeval::["{backend}" == "pdf"]
-https://syncope.apache.org/docs/getting-started.pdf[Apache Syncope Getting
Started Guide]
+https://syncope.apache.org/docs/4.0/getting-started.pdf[Apache Syncope Getting
Started Guide]
endif::[]
for details) allows developers to work comfortably from a single workstation,
with no need of additional setup; it is
effectively implemented as the `all`
diff --git a/src/main/asciidoc/reference-guide/usage/usage.adoc
b/src/main/asciidoc/reference-guide/usage/usage.adoc
index 102feaa63d..cc5e240be5 100644
--- a/src/main/asciidoc/reference-guide/usage/usage.adoc
+++ b/src/main/asciidoc/reference-guide/usage/usage.adoc
@@ -21,10 +21,10 @@
Before proceeding, please ensure that you have access to a running Apache
Syncope deployment.
You can take a look at the
ifeval::["{backend}" == "html5"]
-https://syncope.apache.org/docs/getting-started.html[Apache Syncope Getting
Started Guide]
+https://syncope.apache.org/docs/4.0/getting-started.html[Apache Syncope
Getting Started Guide]
endif::[]
ifeval::["{backend}" == "pdf"]
-https://syncope.apache.org/docs/getting-started.pdf[Apache Syncope Getting
Started Guide]
+https://syncope.apache.org/docs/4.0/getting-started.pdf[Apache Syncope Getting
Started Guide]
endif::[]
to check system requirements and to choose among the various options for
obtaining Apache Syncope.