Skip to content

Commit

Permalink
fix(build): clean adoc errors (#1958)
Browse files Browse the repository at this point in the history
  • Loading branch information
Adrien authored Mar 2, 2022
1 parent 6e2db77 commit b5848e3
Show file tree
Hide file tree
Showing 44 changed files with 189 additions and 200 deletions.
4 changes: 2 additions & 2 deletions modules/ROOT/pages/BonitaBPM_platform_setup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -139,15 +139,15 @@ Before running it, make sure the setup tool is configured to point to the databa
[NOTE]
====
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.
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.
====

Here is how to do so:

. Create the database
. Customize it so it works with Bonita
. Modify the `database.properties` file: Set the right db vendor and change connection url, user credentials, database name and so on.
. 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.
. 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.

[#advanced_use]

Expand Down
10 changes: 5 additions & 5 deletions modules/ROOT/pages/api-extensions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ REST API Extensions use the same authorization mechanism as the standard Bonita
[NOTE]
====
It is also possible to deploy a REST API Extensions using xref:portal-api.adoc]#page[REST portal API / "page" resource].
It is also possible to deploy a REST API Extensions using xref:portal-api.adoc#page[REST portal API / "page" resource].
====

[NOTE]
Expand All @@ -41,7 +41,7 @@ If you are running Bonita in a cluster, after you import a REST API Extensions,
[WARNING]
====
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.
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.
====

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

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)
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. +
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. +
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. +
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.

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

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

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

In a Tomcat / WildFly bundle:

* Retrieve platform configuration using the xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[setup tool].
* Retrieve platform configuration using the xref:BonitaBPM_platform_setup.adoc#update_platform_conf[setup tool].
* Edit `platform_conf/current/tenants/<TENANT_ID>/tenant_portal/custom-permissions-mapping.properties`.
* Add the following line: `profile|User=[demoPermission]`.
* Push the changed platform configuration into database using the _setup tool_.
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/api-glossary.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ Use to represent an instance of a none start event, user task, call activity, mu
For a complete description of the different elements, check out the following pages:

* on the engine side, the http://documentation.bonitasoft.com/javadoc/api/{varVersion}/index.html[Javadoc] page
* on the web site, the xref:_rest-api.adoc[REST API page] page
* on the web site, the xref:rest-api-overview.adoc[REST API page]
4 changes: 2 additions & 2 deletions modules/ROOT/pages/application-api.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ _Example_: /API/living/application?f=token%3dmyapp&d=createdBy
* *Method* +
`GET`
* *URL Params* +
xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available to search form mappings. +
xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available to search form mappings. +
*Required*
** c: number of result per page to retrieve
** p: page number to retrieve
Expand Down Expand Up @@ -425,7 +425,7 @@ _Example_: `http://../API/living/application-menu?p=0&c=2&f=applicationId%3d1`
* *Method* +
`GET`
* *Data Params* +
xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available to search form mappings.
xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available to search form mappings.
** c: number of result per page
** p: page number
** o: can order on "id", "displayName", "applicationId", "applicationPageId", "index", "parentId"
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/applications.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ There are two aspects to updating an application: changing the application defin
. 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.
** To edit the metadata, click the Edit button. In the popup, modify the information about the application, then click *_Save_*.
** To edit the layout, see <<layout,Specifying application layout>>.
** 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])
** 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])
** 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.
Note that if you remove a page, the related menu items are automatically removed from the navigation.
** 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.
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/bdm-in-rest-api.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Image below shows the BDM model used for the first use-case:

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

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
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
configured by selecting the `Only load related objects when needed` radio button).

== Groovy code sample
Expand All @@ -23,7 +23,7 @@ Below is an example of a REST API extension groovy script that accesses the Busi
*Good practices* are:
* If lazy loaded objects are not necessary in the response, ONLY extract the information needed. This avoids costly loading of unnecessary objects.
* 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']
* 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']
in the model.
====

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/bonita-bpm-overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ As mentioned before, xref:bonita-bpm-portal-interface-overview.adoc[Bonita Porta

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].

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

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.

Expand Down
Loading

0 comments on commit b5848e3

Please sign in to comment.