Skip to content

Commit

Permalink
link: and wiki: vs xref: fixes, local docs using xref
Browse files Browse the repository at this point in the history
  • Loading branch information
virgo47 committed Oct 25, 2021
1 parent e6632f1 commit a834154
Show file tree
Hide file tree
Showing 36 changed files with 94 additions and 94 deletions.
6 changes: 3 additions & 3 deletions docs/admin-gui/deployment-information/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Or it may be used as an icon to indicate the environment.
Can be configured with imageUrl attribute or cssClass attribute.
Please, be carefull with the width/height of the logo image, the preferable size is: width up to 300px, height up to 60px.You can either use URL or a relative path.
For custom logos it's best to create a new directory `static-web` under you
link:/midpoint/reference/deployment/midpoint-home-directory/[`midpoint.home`] directory and use a relative link.
xref:/midpoint/reference/deployment/midpoint-home-directory/[`midpoint.home`] directory and use a relative link.

| customerName
| Short name of the organization that is end user of the midPoint deployment.
Expand Down Expand Up @@ -88,5 +88,5 @@ image::image2017-1-30-14-12-38.png[]

== See also

* link:/midpoint/reference/admin-gui/admin-gui-config/[Admin GUI Configuration]
* link:/midpoint/reference/concepts/system-configuration-object/[System Configuration object]
* xref:/midpoint/reference/admin-gui/admin-gui-config/[Admin GUI Configuration]
* xref:/midpoint/reference/concepts/system-configuration-object/[System Configuration object]
4 changes: 2 additions & 2 deletions docs/admin-gui/localization.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ There are some mechanisms in midPoint that make localization of error messages p
However, those mechanisms are still very limited.
We would like to extend this functionality, but it needs to be done in a very sensitive way as overdoing this can ruin maintainability of midPoint code.
And it makes no sense to have perfectly localized system if that system cannot be evolved and fixed efficiently.
However, if you have any ideas or suggestions in this matter please wiki:Participation[contact us]. However, any non-trivial effort in this direction will require wiki:Subscriptions+and+Sponsoring[some funding].
However, if you have any ideas or suggestions in this matter please xref:/community/[contact us]. However, any non-trivial effort in this direction will require wiki:Subscriptions+and+Sponsoring[some funding].


== Plans and Limitations
Expand All @@ -118,4 +118,4 @@ MidPoint does not fully support such deployment and it is expected that a wiki:S

* wiki:PolyString[PolyString]

* wiki:Participation[Participation]
* xref:/community/[Participation]
2 changes: 1 addition & 1 deletion docs/concepts/activation/disable-instead-of-delete.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Following code fragment will create account only after focus has been fully enab

== Examples

There is a complete example in midPoint wiki:Integration+Tests[Integration Tests]:
There is a complete example in midPoint xref:/midpoint/devel/testing/integration/[Integration Tests]:

link:https://github.com/Evolveum/midpoint/blob/master/model/model-intest/src/test/resources/common/resource-dummy-red.xml[https://github.com/Evolveum/midpoint/blob/master/model/model-intest/src/test/resources/common/resource-dummy-red.xml]

Expand Down
14 changes: 7 additions & 7 deletions docs/deployment/midpoint-home-directory/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Initial configuration, log files, connector JAR files, schema customizations and

== Setting Location of MidPoint Home Directory

Easiest way to set the location of midpoint home directory is to set `MIDPOINT_HOME` environment variable before midPoint start script is executed (applies to link:/midpoint/reference/deployment/stand-alone-deployment/[stand-alone deployment] on UNIX systems).
Easiest way to set the location of midpoint home directory is to set `MIDPOINT_HOME` environment variable before midPoint start script is executed (applies to xref:/midpoint/reference/deployment/stand-alone-deployment/[stand-alone deployment] on UNIX systems).

In other cases the `midpoint.home` directory can be specified by setting the `midpoint.home` JVM property (hence the name).
Setting the property depends on the application server or web container that is used to run midPoint but it is usually a variation of the following JVM command-line option:
Expand All @@ -29,7 +29,7 @@ Setting the property depends on the application server or web container that is

The default setting on midPoint home depends on a way how midPoint was deployed.

For link:/midpoint/reference/deployment/stand-alone-deployment/[stand-alone deployment] (which is the default) midPoint home directory is located in `var` sub-directory of midPoint installation.
For xref:/midpoint/reference/deployment/stand-alone-deployment/[stand-alone deployment] (which is the default) midPoint home directory is located in `var` sub-directory of midPoint installation.
E.g. if midPoint was installed in `/opt/midpoint` then midPoint home directory will be located in `/opt/midpoint/var`. This location is determined by startup shell scripts and explicitly passed to midPoint by using `midpoint.home` JVM option.
For UNIX system the location of midPoint home directory can be easily changed by setting `MIDPOINT_HOME` environment variable.

Expand Down Expand Up @@ -57,7 +57,7 @@ MidPoint will try to create the `midpoint.home` directory if it does not already

| lib/
| location for custom JDBC drivers or other custom libraries
| Tested with link:/midpoint/reference/deployment/stand-alone-deployment/[stand-alone deployment]
| Tested with xref:/midpoint/reference/deployment/stand-alone-deployment/[stand-alone deployment]

| log/
| logging directory
Expand All @@ -73,7 +73,7 @@ MidPoint will try to create the `midpoint.home` directory if it does not already

| `logback.xml`
| startup logging configuration
| See link:/midpoint/reference/diag/initial-logging/[Initial Logging Setup HOWTO]
| See xref:/midpoint/reference/diag/initial-logging/[Initial Logging Setup HOWTO]


| `config.xml`
Expand All @@ -87,13 +87,13 @@ MidPoint will try to create the `midpoint.home` directory if it does not already
File `config.xml` located in `midpoint.home` directory is the initial midPoint configuration file.

This is not to be confused with
link:/midpoint/reference/concepts/system-configuration-object/[System Configuration Object]
xref:/midpoint/reference/concepts/system-configuration-object/[System Configuration Object]
which is already a midPoint object stored repository.

See xref:overriding-config-xml-parameters.adoc[] page for ways how to override values
in `config.xml` from the command line.

== See Also

* link:/midpoint/reference/deployment/stand-alone-deployment/[Stand-Alone Deployment]
* link:/midpoint/reference/repository/configuration/[Repository Configuration]
* xref:/midpoint/reference/deployment/stand-alone-deployment/[Stand-Alone Deployment]
* xref:/midpoint/reference/repository/configuration/[Repository Configuration]
16 changes: 8 additions & 8 deletions docs/deployment/stand-alone-deployment.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ It will listen on HTTP port 8080.
[NOTE]
The distribution archive contains a single directory (e.g. `midpoint-4.4`) which is safe to rename after unpacking.
This directory is referred to as *midPoint installation directory* or simply *installation directory*.
This is distinct from link:/midpoint/reference/deployment/midpoint-home-directory/[midPoint home directory],
This is distinct from xref:/midpoint/reference/deployment/midpoint-home-directory/[midPoint home directory],
or `midpoint.home`, which contains runtime configuration, logs, etc.

Please have a look at the xref:/midpoint/quickstart/[] page for basic installation instruction for the purposes of midPoint evaluation or demo.
See link:/midpoint/install/distribution/[Installing MidPoint Server] page for full installation instructions.
See xref:/midpoint/install/distribution/[Installing MidPoint Server] page for full installation instructions.

== Run Control

Expand Down Expand Up @@ -62,7 +62,7 @@ bin/midpoint.sh stop
----

The `midpoint.sh` script may provide more run control and diagnostics capabilities in the future.
See also link:/midpoint/install/midpoint-sh/[midpoint.sh page].
See also xref:/midpoint/install/midpoint-sh/[midpoint.sh page].

=== Windows

Expand Down Expand Up @@ -129,10 +129,10 @@ The compiled files are platform-independent.


| `var`
| Default link:/midpoint/reference/deployment/midpoint-home-directory/[midPoint home directory], also known as `midpoint.home`.
| Default xref:/midpoint/reference/deployment/midpoint-home-directory/[midPoint home directory], also known as `midpoint.home`.
Initial configuration, cryptographic keys, log files and similar "variable" content.
| Read-write
| See link:/midpoint/reference/deployment/midpoint-home-directory/[MidPoint Home Directory].
| See xref:/midpoint/reference/deployment/midpoint-home-directory/[MidPoint Home Directory].


|
Expand All @@ -153,10 +153,10 @@ This information can be used to set up proper file system permission, e.g. in ca
MidPoint comes with an embedded database engine (H2) that is perfectly suitable for testing and demo installations.
This database will be used by midPoint after the installation.
Therefore there is no need to set up a separate database if installing midPoint for the first time.
The database files will be stored in link:/midpoint/reference/deployment/midpoint-home-directory/[midPoint home directory].
The database files will be stored in xref:/midpoint/reference/deployment/midpoint-home-directory/[midPoint home directory].

The database can later be changed to a full-scale database engine.
The link:/midpoint/reference/repository/configuration/[Repository Configuration] page provides the instructions.
The xref:/midpoint/reference/repository/configuration/[Repository Configuration] page provides the instructions.

== Java Memory Setting and Other Options

Expand Down Expand Up @@ -184,4 +184,4 @@ However, it is deprecated, and it may be removed soon.

* xref:/midpoint/quickstart/[]
* xref:/midpoint/install/[]
* link:/midpoint/reference/deployment/midpoint-home-directory/[MidPoint Home Directory]
* xref:/midpoint/reference/deployment/midpoint-home-directory/[MidPoint Home Directory]
8 changes: 4 additions & 4 deletions docs/diag/initial-logging.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

MidPoint logging is usually configured using the administration GUI.
This logging configuration is stored in the midPoint repository (database) so it can only be
applied after basic system infrastructure and link:/midpoint/architecture/archive/subsystems/repo/[repository subsystem] is initialized.
applied after basic system infrastructure and xref:/midpoint/architecture/archive/subsystems/repo/[repository subsystem] is initialized.
Many events are logged before that happens and these are logged using built-in logging configuration.

This initial logging setup may be insufficient for troubleshooting purposes,
Expand Down Expand Up @@ -92,7 +92,7 @@ All the logging goes to the files, or other outputs, where it would go before.

The files above are useful but may be insufficient on their own if the problem happens after
the normal logging is initialized.
This logging is configured in the link:/midpoint/reference/concepts/system-configuration-object/[system
This logging is configured in the xref:/midpoint/reference/concepts/system-configuration-object/[system
configuration object].
If you can't log in or the GUI is otherwise unavailable, the problem may be reported on the level
that does not make it to the log - but would with initial logging overridden as shown above!
Expand Down Expand Up @@ -148,5 +148,5 @@ Sensitive values in logs are protected in all supported 4.x versions, but the ov
== See Also

* xref:/midpoint/reference/deployment/midpoint-home-directory/[MidPoint Home Directory]
* link:/midpoint/reference/diag/logging/[Logging]
* link:/midpoint/reference/deployment/syslog-logging/[Syslog Logging]
* xref:/midpoint/reference/diag/logging/[Logging]
* xref:/midpoint/reference/deployment/syslog-logging/[Syslog Logging]
2 changes: 1 addition & 1 deletion docs/diag/troubleshooting/authorizations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ You will see processing of every operation, every authorization, evaluation of e
Yes, this is no easy task.
Troubleshooting is a hard work.
And this is the best way that we have figured out to troubleshoot the authorizations.
If you have any better idea we are wiki:Participation[more than open to suggestions].
If you have any better idea we are xref:/community/[more than open to suggestions].


== Get Operations
Expand Down
2 changes: 1 addition & 1 deletion docs/diag/troubleshooting/mappings/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ image::9-2-lens-provisioning-structure.png[]



wiki:Architecture+and+Design[MidPoint architecture] is designed in such a way that all important requests pass through the wiki:IDM+Model+Subsystem[IDM Model Subsystem]. This makes sure that all requests are processed consistently, that wiki:Authorization[authorization] is properly applied, that the request is wiki:Auditing[audited], etc.
xref:/midpoint/architecture/[MidPoint architecture] is designed in such a way that all important requests pass through the wiki:IDM+Model+Subsystem[IDM Model Subsystem]. This makes sure that all requests are processed consistently, that wiki:Authorization[authorization] is properly applied, that the request is wiki:Auditing[audited], etc.

Internal implementation of the wiki:IDM+Model+Subsystem[IDM Model Subsystem] heavily relies on wiki:Clockwork+and+Projector[Clockwork and Projector] components.
The Clockwork drives processing of the request.
Expand Down
20 changes: 10 additions & 10 deletions docs/expressions/expressions/script/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -115,20 +115,20 @@ For example, the following expression will evaluate to the content of the `fullN
</code>
----

See link:/midpoint/reference/expressions/expressions/[Expression] page for more generic information about the use of variables in expressions.
See xref:/midpoint/reference/expressions/expressions/[Expression] page for more generic information about the use of variables in expressions.

== Functions

See link:/midpoint/reference/expressions/expressions/script/functions/midpoint/[MidPoint Script Library] for more details.
See xref:/midpoint/reference/expressions/expressions/script/functions/midpoint/[MidPoint Script Library] for more details.

== Absolute and Relative Script Expressions

MidPoint always works with link:/midpoint/reference/concepts/relativity/[relative changes].
MidPoint always works with xref:/midpoint/reference/concepts/relativity/[relative changes].
MidPoint expressions are built for this mode of operation.
The expression will receive every individual value on input and it has to transform that to output.
MidPoint will take care of the logic around it.
If the value was removed in the input, the result will be link:/midpoint/devel/prism/concepts/deltas/[delete delta].
If the value was added in the input the result will be link:/midpoint/devel/prism/concepts/deltas/[add delta].
If the value was removed in the input, the result will be xref:/midpoint/devel/prism/concepts/deltas/[delete delta].
If the value was added in the input the result will be xref:/midpoint/devel/prism/concepts/deltas/[add delta].
MidPoint takes care of all that.
The administrator only needs to specify an expression that transforms one value.

Expand All @@ -151,7 +151,7 @@ On the other hand, in relative approach, each value in UID attribute would be pr

The input to this script is a list of all input values.
The output is a list of new values.
MidPoint always operates in link:/midpoint/reference/concepts/relativity/[relative mode], therefore at the end of the evaluation midPoint will diff the value to create a link:/midpoint/devel/prism/concepts/deltas/[delta]. This does not change anything about that.
MidPoint always operates in xref:/midpoint/reference/concepts/relativity/[relative mode], therefore at the end of the evaluation midPoint will diff the value to create a xref:/midpoint/devel/prism/concepts/deltas/[delta]. This does not change anything about that.
However this mode of expression operation can be an advantage if you need to process all values as a group instead of processing every value one by one.
E.g. in case that you want to choose a particular value or your algorithm depends on other values in some way.

Expand All @@ -169,7 +169,7 @@ The sandbox is not enforced from complexity and performance reasons, but it may
For the time being, please be very careful who can define expressions in midPoint.
Do not allow any untrusted user to modify the expressions.

See link:/midpoint/features/planned/script-expression-sandboxing/[Script Expression Sandboxing] for more details.
See xref:/midpoint/features/planned/script-expression-sandboxing/[Script Expression Sandboxing] for more details.

== Future

Expand All @@ -178,8 +178,8 @@ New expression languages may come in the future if there is a demand for them.

== See Also

* link:/midpoint/reference/expressions/introduction/[Mappings and Expressions]
* xref:/midpoint/reference/expressions/introduction/[Mappings and Expressions]

* link:/midpoint/reference/expressions/expressions/[Expression]
* xref:/midpoint/reference/expressions/expressions/[Expression]

* link:/midpoint/reference/expressions/mappings/[Mapping]
* xref:/midpoint/reference/expressions/mappings/[Mapping]
2 changes: 1 addition & 1 deletion docs/expressions/variables.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ E.g. the variables specific to assignment processing are described in the wiki:A

== Alternative Variable Names and Missing Variables

Although midPoint has wiki:Architecture+and+Design[solid architectural background] it is not a software where every little detail was defined by a big design upfront.
Although midPoint has xref:/midpoint/architecture/[solid architectural background] it is not a software where every little detail was defined by a big design upfront.
MidPoint is continuously evolving.
And also the expression and mapping code is evolving.

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/invoking-midpoint-services/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ REST interface is *WORK IN PROGRESS*. It will be released in midPoint version 3.

* wiki:Interfaces[Interfaces]

* wiki:Architecture+and+Design[Architecture and Design]
* xref:/midpoint/architecture/[Architecture and Design]

* wiki:IDM+Model+Interface[IDM Model Interface]

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/rest/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
*Status:* Public +
*Stability:* [.green]#STABLE#, only backward-compatible changes expected +
*Platform:* RESTful interface +
*Dependencies:* link:/midpoint/reference/schema/[Data Model], Common schema, Query schema +
*Dependencies:* xref:/midpoint/reference/schema/[Data Model], Common schema, Query schema +
*Responsible person:* Katarina Bolemant

== Description
Expand Down
2 changes: 1 addition & 1 deletion docs/legacy/eclipse-plugin/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
[WARNING]
.ABANDONED
====
MidPoint plugin for Eclipse for *abandoned* in favor of link:/midpoint/studio/[MidPoint Studio], which is based on open source link:https://www.jetbrains.com/opensource/idea/[IntelliJ platform].
MidPoint plugin for Eclipse for *abandoned* in favor of xref:/midpoint/studio/[MidPoint Studio], which is based on open source link:https://www.jetbrains.com/opensource/idea/[IntelliJ platform].
Although the Eclipse plugin was an efficient tool used broadly by the community, maintaining the plugin in Eclipse environment proved to be a challenge.
Most of the midPoint developers migrated to link:https://www.jetbrains.com/opensource/idea/[IntelliJ platform], and the popularity of the platform was also indicated by our wiki:MidPoint+2019+Survey+Results[survey]. Therefore we have decided to abandon the old and de facto derelict Eclipse plugin.
Expand Down
2 changes: 1 addition & 1 deletion docs/legacy/eclipse-plugin/install/install.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
[WARNING]
.ABANDONED
====
MidPoint plugin for Eclipse for *abandoned* in favor of link:/midpoint/studio/[MidPoint Studio], which is based on open source link:https://www.jetbrains.com/opensource/idea/[IntelliJ platform].
MidPoint plugin for Eclipse for *abandoned* in favor of xref:/midpoint/studio/[MidPoint Studio], which is based on open source link:https://www.jetbrains.com/opensource/idea/[IntelliJ platform].
Although the Eclipse plugin was an efficient tool used broadly by the community, maintaining the plugin in Eclipse environment proved to be a challenge.
Most of the midPoint developers migrated to link:https://www.jetbrains.com/opensource/idea/[IntelliJ platform], and the popularity of the platform was also indicated by our wiki:MidPoint+2019+Survey+Results[survey]. Therefore we have decided to abandon the old and de facto derelict Eclipse plugin.
Expand Down
2 changes: 1 addition & 1 deletion docs/legacy/eclipse-plugin/release-notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
[WARNING]
.ABANDONED
====
MidPoint plugin for Eclipse for *abandoned* in favor of link:/midpoint/studio/[MidPoint Studio], which is based on open source link:https://www.jetbrains.com/opensource/idea/[IntelliJ platform].
MidPoint plugin for Eclipse for *abandoned* in favor of xref:/midpoint/studio/[MidPoint Studio], which is based on open source link:https://www.jetbrains.com/opensource/idea/[IntelliJ platform].
Although the Eclipse plugin was an efficient tool used broadly by the community, maintaining the plugin in Eclipse environment proved to be a challenge.
Most of the midPoint developers migrated to link:https://www.jetbrains.com/opensource/idea/[IntelliJ platform], and the popularity of the platform was also indicated by our wiki:MidPoint+2019+Survey+Results[survey]. Therefore we have decided to abandon the old and de facto derelict Eclipse plugin.
Expand Down

0 comments on commit a834154

Please sign in to comment.