Skip to content

Commit b5848e3

Browse files
author
Adrien
authored
fix(build): clean adoc errors (#1958)
1 parent 6e2db77 commit b5848e3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+189
-200
lines changed

modules/ROOT/pages/BonitaBPM_platform_setup.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,15 +139,15 @@ Before running it, make sure the setup tool is configured to point to the databa
139139
[NOTE]
140140
====
141141
142-
If you have already run `start-bonita` script inside a xref:tomcat-bundle.adoc]#configuration[Tomcat bundle] or a xref:wildfly-bundle.adoc]]#configuration[WildFly bundle], those steps are already done.
142+
If you have already run `start-bonita` script inside a xref:tomcat-bundle.adoc#configuration[Tomcat bundle] or a xref:wildfly-bundle.adoc#configuration[WildFly bundle], those steps are already done.
143143
====
144144

145145
Here is how to do so:
146146

147147
. Create the database
148148
. Customize it so it works with Bonita
149149
. Modify the `database.properties` file: Set the right db vendor and change connection url, user credentials, database name and so on.
150-
. If you are using an Oracle or Microsoft SQL Server database, add the related xref:database-configuration.adoc]#proprietary_jdbc_drivers[JDBC driver] in the `lib` folder.
150+
. If you are using an Oracle or Microsoft SQL Server database, add the related xref:database-configuration.adoc#proprietary_jdbc_drivers[JDBC driver] in the `lib` folder.
151151

152152
[#advanced_use]
153153

modules/ROOT/pages/api-extensions.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ REST API Extensions use the same authorization mechanism as the standard Bonita
2323
[NOTE]
2424
====
2525
26-
It is also possible to deploy a REST API Extensions using xref:portal-api.adoc]#page[REST portal API / "page" resource].
26+
It is also possible to deploy a REST API Extensions using xref:portal-api.adoc#page[REST portal API / "page" resource].
2727
====
2828

2929
[NOTE]
@@ -41,7 +41,7 @@ If you are running Bonita in a cluster, after you import a REST API Extensions,
4141
[WARNING]
4242
====
4343
44-
As the deployment of the REST API Extensions automatically creates the appropriate resource permission mapping, be careful not to xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[push a configuration] that does not contain the latest permissions updates. This would overwrite the deployed configuration. To avoid doing so, pull the latest configuration, edit the needed elements and push it back to the Bonita runtime in a pretty short amount of time.
44+
As the deployment of the REST API Extensions automatically creates the appropriate resource permission mapping, be careful not to xref:BonitaBPM_platform_setup.adoc#update_platform_conf[push a configuration] that does not contain the latest permissions updates. This would overwrite the deployed configuration. To avoid doing so, pull the latest configuration, edit the needed elements and push it back to the Bonita runtime in a pretty short amount of time.
4545
====
4646

4747
[#usage]
@@ -59,7 +59,7 @@ resources=[GET|extension/demoHeaders,POST|extension/demoXml,PUT|extension/putRes
5959

6060
If the page declares its resources correctly, then every user being able to access this page (because it is part of a custom profile or Living Application they have access to)
6161
will also be automatically granted the necessary permissions to call the REST API Extensions. This works the same way as with the other resources of the REST API. +
62-
However, if you need to grant access to this REST API Extensions to some users regardless of the pages they have access to, then you need to add xref:rest-api-authorization.adoc]#custom-permissions-mapping[custom permissions] for these users. +
62+
However, if you need to grant access to this REST API Extensions to some users regardless of the pages they have access to, then you need to add xref:rest-api-authorization.adoc#custom-permissions-mapping[custom permissions] for these users. +
6363
In order to do so, edit `custom-permissions-mapping.properties` to give the permissions (value of the property `apiExtension.permissions`) declared in the page.properties of the REST API Extensions to the required profiles or users.
6464

6565
[NOTE]
@@ -79,11 +79,11 @@ If you want to disable the debug mode, you need to use the setup tool provided i
7979

8080
A REST API Extensions example resource and API extension viewer page are provided in administrator portal. They are located in administrator portal.
8181

82-
To use the examples, define a xref:rest-api-authorization.adoc]#custom-permissions-mapping[custom permissions] mapping for `demoPermission`:
82+
To use the examples, define a xref:rest-api-authorization.adoc#custom-permissions-mapping[custom permissions] mapping for `demoPermission`:
8383

8484
In a Tomcat / WildFly bundle:
8585

86-
* Retrieve platform configuration using the xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[setup tool].
86+
* Retrieve platform configuration using the xref:BonitaBPM_platform_setup.adoc#update_platform_conf[setup tool].
8787
* Edit `platform_conf/current/tenants/<TENANT_ID>/tenant_portal/custom-permissions-mapping.properties`.
8888
* Add the following line: `profile|User=[demoPermission]`.
8989
* Push the changed platform configuration into database using the _setup tool_.

modules/ROOT/pages/api-glossary.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,4 @@ Use to represent an instance of a none start event, user task, call activity, mu
5959
For a complete description of the different elements, check out the following pages:
6060

6161
* on the engine side, the http://documentation.bonitasoft.com/javadoc/api/{varVersion}/index.html[Javadoc] page
62-
* on the web site, the xref:_rest-api.adoc[REST API page] page
62+
* on the web site, the xref:rest-api-overview.adoc[REST API page]

modules/ROOT/pages/application-api.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ _Example_: /API/living/application?f=token%3dmyapp&d=createdBy
170170
* *Method* +
171171
`GET`
172172
* *URL Params* +
173-
xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available to search form mappings. +
173+
xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available to search form mappings. +
174174
*Required*
175175
** c: number of result per page to retrieve
176176
** p: page number to retrieve
@@ -425,7 +425,7 @@ _Example_: `http://../API/living/application-menu?p=0&c=2&f=applicationId%3d1`
425425
* *Method* +
426426
`GET`
427427
* *Data Params* +
428-
xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available to search form mappings.
428+
xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available to search form mappings.
429429
** c: number of result per page
430430
** p: page number
431431
** o: can order on "id", "displayName", "applicationId", "applicationPageId", "index", "parentId"

modules/ROOT/pages/applications.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ There are two aspects to updating an application: changing the application defin
223223
. Click the Edit icon (...) for the application you want to edit. The application details page is displayed. From this page, you can edit the application metadata, layout, theme, pages, and navigation.
224224
** To edit the metadata, click the Edit button. In the popup, modify the information about the application, then click *_Save_*.
225225
** To edit the layout, see <<layout,Specifying application layout>>.
226-
** To edit the theme, see <<theme,Specifying application theme>>. Note that the end user will see this modification with a delay (due to the xref:cache-configuration-and-policy.adoc]#portal_and_mobile[cache policy])
226+
** To edit the theme, see <<theme,Specifying application theme>>. Note that the end user will see this modification with a delay (due to the xref:cache-configuration-and-policy.adoc#portal_and_mobile[cache policy])
227227
** To edit the pages, go to the Pages zone. You can add a page by clicking *_Add_*. You can remove a page by clicking the trashcan icon for that page.
228228
Note that if you remove a page, the related menu items are automatically removed from the navigation.
229229
** To edit the navigation, go to the Navigation zone. You can add a menu or menu item by clicking *_Add_*. You can remove a menu or menu item by clicking the trashcan icon for that page.

modules/ROOT/pages/bdm-in-rest-api.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Image below shows the BDM model used for the first use-case:
1010

1111
image::images/bdm_model_for_rest_api_01.png[BDM model used]
1212

13-
Note that the relationships from car to wheel1, wheel2, wheel3, wheel4 are *xref:define-and-deploy-the-bdm.adoc]#lazy_eager_loading[lazy] loaded* (in the Studio, it is
13+
Note that the relationships from car to wheel1, wheel2, wheel3, wheel4 are *xref:define-and-deploy-the-bdm.adoc#lazy_eager_loading[lazy] loaded* (in the Studio, it is
1414
configured by selecting the `Only load related objects when needed` radio button).
1515

1616
== Groovy code sample
@@ -23,7 +23,7 @@ Below is an example of a REST API extension groovy script that accesses the Busi
2323
*Good practices* are:
2424
2525
* If lazy loaded objects are not necessary in the response, ONLY extract the information needed. This avoids costly loading of unnecessary objects.
26-
* If lazy loaded objects should always be returned in the response, consider changing the relation from xref:define-and-deploy-the-bdm.adoc]#lazy_eager_loading['lazy' to 'eager']
26+
* If lazy loaded objects should always be returned in the response, consider changing the relation from xref:define-and-deploy-the-bdm.adoc#lazy_eager_loading['lazy' to 'eager']
2727
in the model.
2828
====
2929

modules/ROOT/pages/bonita-bpm-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ As mentioned before, xref:bonita-bpm-portal-interface-overview.adoc[Bonita Porta
3333

3434
But Bonita Portal is also the tool used by the tenant administrator to xref:processes.adoc[install, deploy and manage processes] and to xref:applications.adoc[build applications]. We use the word "tenant" here, in case the platform would be made of xref:multi-tenancy-and-tenant-configuration.adoc[several tenants].
3535

36-
To install Bonita Engine and Bonita Portal in a qualification or production environment, xref:bonita-bpm-installation-overview.adoc]#platform[install Bonita Platform].
36+
To install Bonita Engine and Bonita Portal in a qualification or production environment, xref:bonita-bpm-installation-overview.adoc#platform[install Bonita Platform].
3737

3838
In Bonita Studio, once a process is ready, you can xref:build-a-process-for-deployment.adoc[build] it and deploy it on your Bonita qualification or production platform.
3939

0 commit comments

Comments
 (0)