Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(application): Document how to declare advanced applications. #2705

Closed
wants to merge 10 commits into from

Conversation

vhemery
Copy link
Contributor

@vhemery vhemery commented May 27, 2024

Start skeleton for Bonita UI Designer Pro.
Detail the declaration in app descriptor (temporaryly in sources).

Relates to BPM-91

Start skeleton for Bonita UI Designer Pro.
Detail the declaration in app descriptor (temporaryly in sources).

Relates to [BPM-91](https://bonitasoft.atlassian.net/browse/BPM-91)
@CLAassistant
Copy link

CLAassistant commented May 27, 2024

CLA assistant check
All committers have signed the CLA.

@vhemery vhemery changed the base branch from 2022.2 to 2024.3 May 27, 2024 12:33
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 11.2%, saving 9.92 KB.

Filename Before After Improvement Visual comparison
modules/pages-and-forms/assets/images/images/advanced-application-descriptor.png 88.41 KB 78.49 KB -11.2% View diff

266 images did not require optimisation.

Copy link
Contributor

github-actions bot commented May 27, 2024

🎊 PR Preview d287ccc has been successfully built and deployed to https://bonitasoft-bonita-doc-build_preview-pr-2705.surge.sh

🕐 Build time: 0.01s

🤖 By surge-preview

Copy link
Contributor

github-actions bot commented May 27, 2024

📝 Check the pages that have been modified

In order to merge this pull request, you need to check your updates with the following url.

🔍 Updated pages

The following pages were updated, please ensure that the display is correct:

Copy link
Contributor

@jeromecambon jeromecambon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, few comments (on the form)

@vhemery vhemery requested a review from jeromecambon May 28, 2024 08:10
Copy link
Contributor

@jeromecambon jeromecambon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems good!

@jeromecambon jeromecambon reopened this Jun 4, 2024
The xref:applications:application-creation.adoc[Bonita application descriptor] is a file that let you describe all your applications.

To declare a Bonita UI Designer Pro interface in it, edit it in Studio using the "source" tab.
In this tab, you will be able to declare your application built and packaged with Bonita UI Designer Pro, using auto-completion with a "advancedApplication" XML tag.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion:

Suggested change
In this tab, you will be able to declare your application built and packaged with Bonita UI Designer Pro, using auto-completion with a "advancedApplication" XML tag.
In this tab, you will be able to declare your application built and packaged with Bonita UI Designer Pro, using auto-completion with a `advancedApplication` XML tag.


The xref:applications:application-creation.adoc[Bonita application descriptor] is a file that let you describe all your applications.

To declare a Bonita UI Designer Pro interface in it, edit it in Studio using the "source" tab.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion:

Suggested change
To declare a Bonita UI Designer Pro interface in it, edit it in Studio using the "source" tab.
To declare a Bonita UI Designer Pro interface in it, edit it in Studio using the `source` tab.


image::images/advanced-application-descriptor.png[Application Descriptor Editor]

In this example, the "Advanced Overview" application is declared with the tag:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion:

Suggested change
In this example, the "Advanced Overview" application is declared with the tag:
In this example, the _Advanced Overview_ application is declared with the tag:

</advancedApplication>
----

There are fewer properties to set for an advanced application than for a legacy application, but the "displayName" is still mandatory.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion:

Suggested change
There are fewer properties to set for an advanced application than for a legacy application, but the "displayName" is still mandatory.
There are fewer properties to set for an advanced application than for a legacy application, but the `displayName` is still mandatory.


image::images/advanced-application-descriptor.png[Application Descriptor Editor]

In this example, the "Advanced Overview" application is declared with the tag:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick:
For blind people, it's not clear whether to add this snippet code inside the <applications></applications> tag.

@jeromecambon
Copy link
Contributor

This PR will be closed soon, it's replaced by #2714

@vhemery vhemery closed this Jun 5, 2024
@vhemery vhemery deleted the feat/declare_app_uid_pro branch June 5, 2024 07:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants