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

docs: Move in production with bonita-ui-builder #2739

Open
wants to merge 13 commits into
base: 2024.3
Choose a base branch
from

Conversation

benjaminParisel
Copy link
Contributor

@benjaminParisel benjaminParisel commented Jun 17, 2024

Explain how to go in production and the user flow with bonita-ui-builder

@benjaminParisel benjaminParisel changed the title doc: Go in production with bonita-ui-builder docs: Go in production with bonita-ui-builder Jun 17, 2024
Copy link

github-actions bot commented Jun 17, 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:

⚠️ Check redirects

At least one page has been renamed, moved or deleted in the Pull Request. Make sure to add aliases and verify that the following links redirect to the right location:

Copy link

github-actions bot commented Jun 17, 2024

🎊 PR Preview 2b1d0c3 has been successfully built and deployed to https://bonitasoft-bonita-doc-deploy-pr-2739.surge.sh

🕐 Build time: 0.01s

🤖 By surge-preview

@marcobonita
Copy link
Contributor

Hi @benjaminParisel,
I'd like to suggest a few adjustments on package-and-deploy-your-application.adoc. Since I can't make a review on github, I wrote them down in this doc : https://docs.google.com/document/d/1C1fRjMa7QS9cv531-d95BF4Lup_67v5eSHs6_hcNAo0/edit?usp=sharing

@benjaminParisel benjaminParisel changed the title docs: Go in production with bonita-ui-builder docs: Move in production with bonita-ui-builder Jun 19, 2024
@benjaminParisel benjaminParisel marked this pull request as ready for review June 19, 2024 12:18
Copy link
Contributor

@vhemery vhemery left a comment

Choose a reason for hiding this comment

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

See remark on cards.
Please answer question on dockerfile (I sincerely do not know).

Copy link
Contributor

@vhemery vhemery Jun 24, 2024

Choose a reason for hiding this comment

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

Could you reorder the cards so they are in the same order as the tree ? "UI Builder configuration" should come second logically.
Also, we are missing the card to "create-an-interface" page.

Copy link
Contributor

Choose a reason for hiding this comment

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

Strange... The preview did not update correctly.
Also the sections are duplicated in the "initiation-manual" page.
So we need to keep the 2 in sync (and I prefer the card description from "initiation-manual" for "Create and interface").

Is there an easy way to avoid duplicating the cards ?
https://bonitasoft-bonita-doc-deploy-pr-2739.surge.sh/bonita/latest/applications/bonita-ui-builder
https://bonitasoft-bonita-doc-deploy-pr-2739.surge.sh/bonita/latest/applications/initiation-manual

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sometime, you need to refresh your browser cache to see the new version publish (I didn't try it)

Copy link
Contributor

Choose a reason for hiding this comment

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

Strange... The preview did not update correctly.
Also the sections are duplicated in the "initiation-manual" page.
So we need to keep the 2 in sync (and I prefer the card description from "initiation-manual" for "Create and interface").

Is there an easy way to avoid duplicating the cards ?
https://bonitasoft-bonita-doc-deploy-pr-2739.surge.sh/bonita/latest/applications/bonita-ui-builder
https://bonitasoft-bonita-doc-deploy-pr-2739.surge.sh/bonita/latest/applications/initiation-manual

Copy link
Contributor

@vhemery vhemery left a comment

Choose a reason for hiding this comment

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

LGTM. Only preview looks broken...


== Prerequisites

Before starting, ensure you have **Docker** the following tools installed on your system.
Copy link
Contributor

Choose a reason for hiding this comment

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

This prerequisite is for all the UI Builder usage, so I suggest to not put it there. If you do, remove "the following tools".


=== Export Your Application

Once the design is complete, export the application(s) from Bonita UI Builder by clicking the `export` button on the home page. This export will be used for building the production binary.
Copy link
Contributor

Choose a reason for hiding this comment

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

Give more details on where the "export" button is located, this is not obvious...

modules/applications/pages/production-packaging.adoc Outdated Show resolved Hide resolved
modules/applications/pages/production-packaging.adoc Outdated Show resolved Hide resolved
- `LOGGING_LEVEL_COM_EXTERNAL_PLUGINS`: Sets the logging level for external plugins. (default is `debug`)

[.troubleshooting-title]
== image:ROOT:images/troubleshooting.png[troubleshooting-icon] Troubleshooting
Copy link
Contributor

Choose a reason for hiding this comment

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

Troubleshooting icon appears twice

Copy link

Images automagically compressed by Calibre's image-actions

Compression reduced images by 25.7%, saving 7.17 KB.

Filename Before After Improvement Visual comparison
modules/applications/assets/images/images/advanced-app/export-application.png 27.91 KB 20.74 KB -25.7% View diff

274 images did not require optimisation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
5 participants