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

[JBPM-10084]-Remove references of the start.jbpm.org in docs #204

Merged
merged 4 commits into from Aug 2, 2022

Conversation

VaniHaripriya
Copy link
Contributor

Jira- https://issues.redhat.com/browse/JBPM-10084
Removed all the references for start.jbpm.org in Gettingstarted doc

Copy link
Member

@gmunozfe gmunozfe left a comment

Choose a reason for hiding this comment

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

Looks good to me, just minor format comments


* Generate default application - that gives you all default settings to get started as fast as possible
* Configure projects and capabilities - that gives you few options to select from before generating application
It is recommended to generate all the three types of projects -Data Model, Business assets and Service projects using the archetypes in same directory on your computer.
Copy link
Member

Choose a reason for hiding this comment

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

Missing closing dash


There are two options you can get your application
To build your first business application,use the above mentioned maven archetype commands to generate a Data project,Business assets project and a Service project with desired capabilities.
Copy link
Member

Choose a reason for hiding this comment

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

Missing blanks after comma

Copy link
Contributor

@hbelmiro hbelmiro left a comment

Choose a reason for hiding this comment

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

@VaniHaripriya the variables are not being resolved. I left a comment in the code with the explanation. Let me know if you need any help with that.

----
mvn archetype:generate -B -DarchetypeGroupId=org.kie -DarchetypeArtifactId=kie-kjar-archetype -DarchetypeVersion={COMMUNITY_VERSION_FINAL} -DgroupId=com.company -DartifactId=business-application-kjar -Dversion=1.0-SNAPSHOT -Dpackage=com.company
----
`org.kie:kie-kjar-archetype:{COMMUNITY_VERSION_FINAL}`
Copy link
Contributor

Choose a reason for hiding this comment

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

This doesn't work as you expect. The variables aren't resolved when you build the website.

Due to a bug in JBake, the only way I managed to make variables work is by converting the adoc content to ftl. You can see how I did it in https://github.com/kiegroup/jbpm-website/blob/main/templates/_content_businessapps_examples.ftl. This template is used by https://github.com/kiegroup/jbpm-website/blob/main/content/businessapps/examples.adoc

You can use https://asciidoclive.com/edit/scratch/1 to convert the adoc code to HTML. You can see the generated HTML by clicking on the gear icon in the top right corner and then click in "Show output HTML".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you Helber, made the changes as suggested.

Copy link
Contributor

@hbelmiro hbelmiro left a comment

Choose a reason for hiding this comment

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

Great work @VaniHaripriya.
LGTM. Thank you.

@hbelmiro hbelmiro requested a review from mbiarnes June 29, 2022 19:22
@VaniHaripriya
Copy link
Contributor Author

_content_businessapps_gettingStarted.pdf
Attaching the preview for Gettingstarted page.

Comment on lines 153 to 156
<p>Business automation(bpm) covers features for process management, case management,
decision management and optimization. These will be by default configured
in the service project of your business application. Although you can
turn them off via configurationService project archetype(Business Automation)</p>
Copy link
Member

@lazarotti lazarotti Jul 1, 2022

Choose a reason for hiding this comment

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

It is not clear the last sentence "Although you can turn them off via configurationService project archetype(Business Automation)" what do you mean by configurationService project archetype(Business Automation)? Can you elaborate or provide an example?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That line was not supposed to be there Alessandro. Removed it now.

project with desired capabilities.</p>
</div>
<div class="paragraph">
<p>It is recommended to generate all the three types of projects -Data Model,
Copy link
Member

Choose a reason for hiding this comment

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

replace -Data Model to Data Model (remove the - signal)

@lazarotti
Copy link
Member

all good for me @VaniHaripriya
Let me know when the site is updated, so I can ask to redirect the start.jbpm.org to this page

@VaniHaripriya
Copy link
Contributor Author

all good for me @VaniHaripriya Let me know when the site is updated, so I can ask to redirect the start.jbpm.org to this page

Thank you Alessandro, I will let you know once it is updated.

@mbiarnes mbiarnes merged commit 4c5d792 into kiegroup:main Aug 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants