feat: adding communication content about UIB #2722

vhemery · 2024-06-07T14:44:07Z

No description provided.

changes to titles

github-actions · 2024-06-07T14:45:03Z

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

🕐 Build time: 0.008s

_{🤖 By surge-preview}

github-actions · 2024-06-07T14:45:41Z

📝 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:

vhemery · 2024-06-07T15:03:49Z

modules/applications/pages/bonita-ui-builder.adoc

@@ -1,23 +1,43 @@
 = Applications with Bonita UI Builder
 :page-aliases: ROOT:bonita-ui-builder.adoc
-:description: Bonita UI Builder allows to build the UI of an application.
+:description: In this section, you will learn more about: Bonita UI Builder, its purpose, how to subscribe and start using it, as well as Applications.
 They are not anymore standalone elements (such as pages and forms) in a process (paradigm change with legacy Bonita UI Designer).

 {description}

 [.card-section]


The goal of these sections was to have cards like on https://bonitasoft-bonita-doc-build_preview-pr-2722.surge.sh/bonita/latest/applications/uid-applications-index
If we do not use cards, [.card-section] should be removed entirely.

Cards are nice, as they provide a quick display without a lot of text to read.
Do we really want o get rid of cards here ?

We could have both presentation text and cards, as done in the Getting Started Tutorial.

vhemery · 2024-06-07T15:06:11Z

modules/applications/pages/faq.adoc

+You existing forms and pages will always be compatible with Bonita. Eventually, Bonita UI Designer will be phased out as we fully transition to Bonita UI Builder. We cannot guarantee you will be able to edit your existing interfaces made with Bonita UI Designer in the future versions of Bonita.
+
+Our goal is to make this transition as smooth as possible, minimizing any disruption to your workflow:
+* Continued access: Bonita UI Designer will remain fully operational for an extended period, allowing ample time for adaptation.


Insert blank line before.

vhemery · 2024-06-07T15:09:32Z

modules/applications/applications-nav.adoc

@@ -10,7 +10,7 @@
  *** xref:how-tos-builder.adoc[How-tos]
  *** xref:resources.adoc[Resources]
  *** xref:faq.adoc[FAQ]
- ** xref:custom-applications-index.adoc[Living applications with Bonita UID (Legacy)]
+ ** xref:uid-applications-index.adoc[Living applications with Bonita UID]


custom-applications-index.adoc should be removed.
I guess uid-applications-index.adoc is just a copy of it ?

custom-applications-index.adoc should also be added to aliases in uid-applications-index.adoc

Why should it be removed?

custom-applications-index.adoc and uid-applications-index.adoc are 2 distinct pages and will have different content

custom-applications-index.adoc is the one about Legacy UID, so I don't understand what the difference would be with uid-applications-index
custom-applications-index.adoc is no longer accessible from the navigation.

I do understand the need for renaming as "custom-" is ambiguous. But if that's not a page renaming, then I don't understand the change.

Aliases are here to ensure the correct redirection in case of page renaming.

As it is now, "Living applications" and "Living applications with Bonita UID (legacy)" are both on custom-applications-index.adoc with the same content, and I want to avoid that and split them into 2 different pages (since they will have different content). Hence this change

jeromecambon

Looks good, some comments to address.

jeromecambon · 2024-06-07T15:38:56Z

modules/applications/pages/bonita-ui-builder.adoc

@@ -1,23 +1,43 @@
 = Applications with Bonita UI Builder
 :page-aliases: ROOT:bonita-ui-builder.adoc
-:description: Bonita UI Builder allows to build the UI of an application.
+:description: In this section, you will learn more about: Bonita UI Builder, its purpose, how to subscribe and start using it, as well as Applications.
 They are not anymore standalone elements (such as pages and forms) in a process (paradigm change with legacy Bonita UI Designer).

 {description}

 [.card-section]


We could have both presentation text and cards, as done in the Getting Started Tutorial.

jeromecambon · 2024-06-07T15:39:35Z

modules/applications/pages/bonita-ui-builder.adoc

--
+
+Bonita UI Builder is a development environment made for designing all kind of interfaces, pages, forms, for your applications. It brings a host of advanced features and improved usability, designed to help you create even more compelling and user-friendly interfaces: a set of more than 45 widgets, a wide gallery template, code completion, custom JS code, native debugging option, a restriction-free drag & drop interface, import and export JSON options, React interfaces, and many more.
+


Too long sentence, hard to read.

Should we use a list instead?

jeromecambon · 2024-06-07T15:41:09Z

modules/applications/pages/bonita-ui-builder.adoc

+
+With Bonita UI Builder, you can still manage your workflows, continuous integration, etc., the way you’re managing them now. 
+
+We offer xref:applications:initiation-manual.adoc[extensive documentation], xref:applications:how-tos-builder.adoc[tutorials], and a xref:applications:faq.adoc[FAQ] to help you make the most of Bonita UI Builder.


Can be replaced by cards.

Maybe the text was written with the help of GPT ?

jeromecambon · 2024-06-07T15:43:45Z

modules/applications/pages/bonita-ui-builder.adoc

+
+They are a navigation of pages that can be accessed by a xref:identity:profiles-overview.adoc[Profile]. They aim to display and structure the right information and provide the right controls at the right time to the profiles, so they can efficiently perform their tasks. Once pushed to production, Applications cannot be live edited.
+
+Bonita also comes with four Bonita Applications.


We should list them, to be more precise.

List the 4 bonita applications you mean?

Le lien a sauté lors des copier-coller. Il faudrait que [Bonita applications] redirige vers https://documentation.bonitasoft.com/bonita/latest/runtime/bonita-applications-interface-overview

jeromecambon · 2024-06-07T15:45:39Z

modules/applications/pages/bonita-ui-builder.adoc

+
+Bonita also comes with four Bonita Applications.
+
+“Applications” are very similar to “Living Applications”, which are created with Bonita UI Designer and will be phased out.


We should say the difference, at least move the "Once pushed to production, Applications cannot be live edited" sentence here.

jeromecambon · 2024-06-07T15:49:51Z

modules/applications/pages/faq.adoc

+== Bonita UI Builder
+
+=== What is Bonita UI Builder? 
+Bonita UI Designer (sometimes abbreviated UIB) is a development environment used for creating all kind on interfaces, whether they are pages or forms or else, that make up an Application. It is a web-based tool that is launched from a Bonitasoft custom docker image. It is the new and only standard used in the Bonita ecosystem for designing interfaces.


Suggested change

Bonita UI Designer (sometimes abbreviated UIB) is a development environment used for creating all kind on interfaces, whether they are pages or forms or else, that make up an Application. It is a web-based tool that is launched from a Bonitasoft custom docker image. It is the new and only standard used in the Bonita ecosystem for designing interfaces.

Bonita UI Builder (sometimes abbreviated UIB) is a development environment used for creating all kind on interfaces, whether they are pages or forms or else, that make up an Application. It is a web-based tool that is launched from a Bonitasoft custom docker image. It is the new and only standard used in the Bonita ecosystem for designing interfaces.

jeromecambon · 2024-06-07T15:53:07Z

modules/applications/pages/faq.adoc

+|Yes
+|Yes
+
+|Undo/redo


Suggested change

|Undo/redo

|Undo/redo, copy/paste

marcobonita · 2024-06-12T09:18:14Z

Hi @vhemery do you have everything you need to make the changes?

vhemery · 2024-06-12T13:49:39Z

Hi @vhemery do you have everything you need to make the changes?

@marcobonita I'm not working on the project... I only created the PR on the project to help you with the previews to make it easier to review your PR.
Is it in the scope of the documentation project by @jeromecambon ?
Please check with UI Builder team who can address this.

marcobonita · 2024-06-13T05:29:10Z

Hi @vhemery do you have everything you need to make the changes?

@marcobonita I'm not working on the project... I only created the PR on the project to help you with the previews to make it easier to review your PR. Is it in the scope of the documentation project by @jeromecambon ? Please check with UI Builder team who can address this.

So should we close this PR and open another one with the changes suggested? @vhemery @jeromecambon

marcobonita · 2024-06-14T06:28:06Z

Can be closed, I'll create a new PR

Content of #2722 + suggested changes --------- Co-authored-by: Benjamin Parisel <benjamin.parisel@bonitasoft.com> Co-authored-by: Romain Bioteau <romain.bioteau@bonitasoft.com>

marcobonita added 12 commits June 7, 2024 16:43

Update bonita-ui-builder.adoc

fa45288

Update applications-nav.adoc

dde32d6

Create uid-applications-index.adoc

271f06e

Update uid-applications-index.adoc

f89bc0b

Update project-structure.adoc

a275acb

Update ui-designer-overview.adoc

4a4cd6b

Update glossary.adoc

57ae8c6

Update create-web-user-interfaces.adoc

0f4e705

Update design-application-page.adoc

f20d0c6

Update release-notes.adoc

7a41b75

Update faq.adoc

dc2c388

Update faq.adoc

08e2cd5

changes to titles

vhemery commented Jun 7, 2024

View reviewed changes

jeromecambon requested changes Jun 7, 2024

View reviewed changes

marcobonita mentioned this pull request Jun 14, 2024

feat: adding UIB communication content (#2722 improvement) #2732

Closed

marcobonita mentioned this pull request Jun 14, 2024

feat: adding UIB communication content (#2722 improvement) #2733

Merged

vhemery closed this Jun 14, 2024

tbouffard deleted the marcobonita_patch-15 branch August 28, 2024 09:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: adding communication content about UIB #2722

feat: adding communication content about UIB #2722

vhemery commented Jun 7, 2024

github-actions bot commented Jun 7, 2024 •

edited

Loading

github-actions bot commented Jun 7, 2024

vhemery Jun 7, 2024

jeromecambon Jun 7, 2024

vhemery Jun 7, 2024

vhemery Jun 7, 2024

marcobonita Jun 10, 2024

vhemery Jun 10, 2024

marcobonita Jun 11, 2024

jeromecambon left a comment

jeromecambon Jun 7, 2024

jeromecambon Jun 7, 2024

marcobonita Jun 10, 2024

jeromecambon Jun 7, 2024

vhemery Jun 7, 2024 •

edited

Loading

jeromecambon Jun 7, 2024

marcobonita Jun 10, 2024

marcobonita Jun 10, 2024

jeromecambon Jun 7, 2024

jeromecambon Jun 7, 2024

jeromecambon Jun 7, 2024

marcobonita commented Jun 12, 2024

vhemery commented Jun 12, 2024

marcobonita commented Jun 13, 2024

marcobonita commented Jun 14, 2024 •

edited

Loading

		--

		Bonita UI Builder is a development environment made for designing all kind of interfaces, pages, forms, for your applications. It brings a host of advanced features and improved usability, designed to help you create even more compelling and user-friendly interfaces: a set of more than 45 widgets, a wide gallery template, code completion, custom JS code, native debugging option, a restriction-free drag & drop interface, import and export JSON options, React interfaces, and many more.


		With Bonita UI Builder, you can still manage your workflows, continuous integration, etc., the way you’re managing them now.

		We offer xref:applications:initiation-manual.adoc[extensive documentation], xref:applications:how-tos-builder.adoc[tutorials], and a xref:applications:faq.adoc[FAQ] to help you make the most of Bonita UI Builder.


		They are a navigation of pages that can be accessed by a xref:identity:profiles-overview.adoc[Profile]. They aim to display and structure the right information and provide the right controls at the right time to the profiles, so they can efficiently perform their tasks. Once pushed to production, Applications cannot be live edited.

		Bonita also comes with four Bonita Applications.


		Bonita also comes with four Bonita Applications.

		“Applications” are very similar to “Living Applications”, which are created with Bonita UI Designer and will be phased out.

	Bonita UI Designer (sometimes abbreviated UIB) is a development environment used for creating all kind on interfaces, whether they are pages or forms or else, that make up an Application. It is a web-based tool that is launched from a Bonitasoft custom docker image. It is the new and only standard used in the Bonita ecosystem for designing interfaces.
	Bonita UI Builder (sometimes abbreviated UIB) is a development environment used for creating all kind on interfaces, whether they are pages or forms or else, that make up an Application. It is a web-based tool that is launched from a Bonitasoft custom docker image. It is the new and only standard used in the Bonita ecosystem for designing interfaces.

feat: adding communication content about UIB #2722

feat: adding communication content about UIB #2722

Conversation

vhemery commented Jun 7, 2024

github-actions bot commented Jun 7, 2024 • edited Loading

github-actions bot commented Jun 7, 2024

📝 Check the pages that have been modified

🔍 Updated pages

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeromecambon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vhemery Jun 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcobonita commented Jun 12, 2024

vhemery commented Jun 12, 2024

marcobonita commented Jun 13, 2024

marcobonita commented Jun 14, 2024 • edited Loading

github-actions bot commented Jun 7, 2024 •

edited

Loading

vhemery Jun 7, 2024 •

edited

Loading

marcobonita commented Jun 14, 2024 •

edited

Loading