forked from apache/incubator-kie-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
BXMSDOC-5434-master: Update configuring business central settings and…
… properties doc per changes in RHDM/RHPAM 7.7 (#56) (apache#2238) * BXMSDOC-5434-master: Added a new chapter Archetype management in the document. * BXMSDOC-5434-master: Incorporated the changes on the basis of SME review. * BXMSDOC-5434-master: Incorporated the changes on the basis on Peer and QE reviews. * BXMSDOC-5434-master: Reverted the red icon changes as per QE review.
- Loading branch information
Showing
7 changed files
with
106 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
17 changes: 17 additions & 0 deletions
17
...rise-only/admin-and-config/managing-business-central-adding-archetype-proc.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| [id='managing-business-central-adding-archetype-proc'] | ||
| = Adding an archetype | ||
|
|
||
| You can add a new archetype to {CENTRAL}. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * You have installed an archetype in the Maven repository. | ||
|
|
||
| .Procedure | ||
|
|
||
| . In {CENTRAL}, select the *Admin* icon in the top-right corner of the screen and select *Archetypes*. | ||
| . Click *Add Archetype*. | ||
| . In the *Add Archetype* panel, enter the GAV attributes in the *Group ID*, *Artifact ID*, and *Version* fields respectively. | ||
| . Click *Add*. | ||
|
|
||
| {CENTRAL} validates the newly added archetype and make it available to be used as a template in all the spaces. |
21 changes: 21 additions & 0 deletions
21
...in-and-config/managing-business-central-additional-features-archetype-proc.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| [id='managing-business-central-additional-features-archetype-proc'] | ||
| = Managing additional features of an archetype | ||
|
|
||
| You can delete, set a default, and validate the archetypes from the *Archetypes* page in {CENTRAL}. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * You have created an archetype and listed in the {CENTRAL} *Settings* from the Maven repository. | ||
|
|
||
| .Procedure | ||
|
|
||
| . In {CENTRAL}, select the *Admin* icon in the top-right corner of the screen and select *Archetypes*. | ||
| . From the *Actions* column, click the image:project-data/dots.png[] icon on the right side of an archetype. | ||
| * Select *Delete* from the drop-down menu to delete an archetype from the list. | ||
| * Select *Validate* from the drop-down menu to validate whether the archetype is valid or not. | ||
| + | ||
| [NOTE] | ||
| ==== | ||
| When the {CENTRAL} is starting up, all the registered archetypes are automatically validated. | ||
| ==== | ||
| * Select *Set as default* from the drop-down menu to set an archetype as a default for the new spaces. |
6 changes: 6 additions & 0 deletions
6
...t/enterprise-only/admin-and-config/managing-business-central-archetype-con.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| [id='managing-business-central-archetype-con'] | ||
| = Archetype management | ||
|
|
||
| {CENTRAL} provides an archetype management feature that enables you to list, add, validate, set as default, and delete the archetypes. You can manage archetypes from the *Archetypes* page in {CENTRAL}. Archetypes are projects that are installed in Apache Maven repositories in which a template structure is set or can be created if required. | ||
|
|
||
| For the most up-to-date and detailed information about archetypes, see the https://maven.apache.org/guides/introduction/introduction-to-archetypes.html[Introduction to Archetypes page]. |
18 changes: 18 additions & 0 deletions
18
...y/admin-and-config/managing-business-central-archetype-space-settings-proc.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| [id='managing-business-central-archetype-space-settings-proc'] | ||
| = Managing archetypes using space settings in {CENTRAL} | ||
|
|
||
| When you add the archetypes to {CENTRAL}, they can be used as a templates in all the spaces. You can manage all the archetypes from the *Settings* tab which is available in the space. This tab is visible only to users with the `admin` role. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * You have installed an archetype in the Maven repository. | ||
| * You have created an archetype and listed it in the {CENTRAL} *Settings* from the Maven repository. | ||
|
|
||
| .Procedure | ||
|
|
||
| . In {CENTRAL}, go to *Menu* -> *Design* -> *Projects*. | ||
| . Select or create the space into which you want to manage the archetypes. The default space is *MySpace*. | ||
| . Click *Settings*. | ||
| . To include or exclude the archetypes in the space, select the *Include* check box. | ||
| . From the *Actions* column, click the image:project-data/dots.png[] icon on the right side of an archetype and select *Set as default* from the drop-down menu to set an archetype as a default for the space. | ||
| . Click *Save*. |
22 changes: 22 additions & 0 deletions
22
...admin-and-config/managing-business-central-creating-archetype-project-proc.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| [id='managing-business-central-creating-archetype-project-proc'] | ||
| = Creating a project using archetypes | ||
|
|
||
| You can use archetypes to create a project in {CENTRAL}. When you create a project in {CENTRAL}, it is added to the Git repository that is connected to your {PRODUCT} installation. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * You have created an archetype and listed it in the {CENTRAL} *Settings* from the Maven repository. | ||
| * You have set an archetype as default in your space in the {CENTRAL}. | ||
|
|
||
| .Procedure | ||
|
|
||
| . In {CENTRAL}, go to *Menu* -> *Design* -> *Projects*. | ||
| . Select or create the space into which you want to add a new project from an archetype template. | ||
| . Click *Add Project*. | ||
| . Type the project name and description in the *Name* and *Description* fields respectively. | ||
| . Click *Configure Advanced Options*. | ||
| . Select the *Based on template* check box. | ||
| . Select the archetype from drop-down options if required. The default archetype is selected that is already set in the space. | ||
| . Click *Add*. | ||
|
|
||
| The *Assets* view of the project opens based on the selected archetype template. |
14 changes: 14 additions & 0 deletions
14
...ise-only/admin-and-config/managing-business-central-listing-archetype-proc.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| [id='managing-business-central-listing-archetype-proc'] | ||
| = Listing archetypes | ||
|
|
||
| The *Archetypes* page lists all the archetypes that are added in {CENTRAL}. This list provides the detailed information about *Group ID*, *Artifact ID*, *Version*, *Created Date*, *Status*, and *Actions* of an archetype. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * You have created an archetype and listed it in the {CENTRAL} *Settings* from the maven repository. | ||
|
|
||
| .Procedure | ||
|
|
||
| . In {CENTRAL}, select the *Admin* icon in the top-right corner of the screen and select *Archetypes*. | ||
| + | ||
| In the *Status* column, green icon indicates it is a valid archetype, red icon indicates it is an invalid archetype whereas blue icon indicates the corresponding archetype is the default one for the new spaces. |