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

[incubator-kie-issues#1395] Write developer documentation for the DMN implementation #6029

Merged
merged 7 commits into from
Jul 23, 2024

Conversation

gitgabrio
Copy link
Contributor

Fixes apache/incubator-kie-issues#1395

@bncriju

How to replicate CI configuration locally?

Build Chain tool does "simple" maven build(s), the builds are just Maven commands, but because the repositories relates and depends on each other and any change in API or class method could affect several of those repositories there is a need to use build-chain tool to handle cross repository builds and be sure that we always use latest version of the code for each repository.

build-chain tool is a build tool which can be used on command line locally or in Github Actions workflow(s), in case you need to change multiple repositories and send multiple dependent pull requests related with a change you can easily reproduce the same build by executing it on Github hosted environment or locally in your development environment. See local execution details to get more information about it.

How to retest this PR or trigger a specific build:
  • for pull request and downstream checks

    • Push a new commit to the PR. An empty commit would be enough.
  • for a full downstream build

    • for github actions job: add the label run_fdb
  • for Jenkins PR check only

@tiagobento
Copy link
Contributor

tiagobento commented Jul 22, 2024

Hi @gitgabrio, I have some questions about the .puml files you added... I see they're also present for documenting other parts of the project, but I'm not familiar with them. Do you mind providing details about how to edit, visualize, re-generate the PNGs based on them? I'm asking because these diagrams can change in the future, based on changes applied to the code, so having instructions on how to manage them is essential for keeping these docs up-to-date. Thanks in advance! And sorry if this is already written somewhere I didn't find.

Copy link
Contributor

@bncriju bncriju left a comment

Choose a reason for hiding this comment

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

This documentation is readable and understandable even to a new person who might not have complete knowledge of the same. It was nice if the sections 'Interpreted vs Codegen' and 'Coercion' were little more explanatory. Thanks

Copy link
Contributor

@bncriju bncriju left a comment

Choose a reason for hiding this comment

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

Changes made look good and now the sections mentioned are easy to be understood. Also the main Readme looks good. Thanks

@gitgabrio
Copy link
Contributor Author

Hi @gitgabrio, I have some questions about the .puml files you added... I see they're also present for documenting other parts of the project, but I'm not familiar with them. Do you mind providing details about how to edit, visualize, re-generate the PNGs based on them? I'm asking because these diagrams can change in the future, based on changes applied to the code, so having instructions on how to manage them is essential for keeping these docs up-to-date. Thanks in advance! And sorry if this is already written somewhere I didn't find.

Since it involves different modules, I add it to top-level "Readme"

@gitgabrio gitgabrio merged commit b00ef1d into apache:main Jul 23, 2024
10 checks passed
@gitgabrio gitgabrio deleted the incubator-kie-issues#1395 branch July 23, 2024 13:12
rgdoliveira pushed a commit to rgdoliveira/drools that referenced this pull request Aug 6, 2024
… implementation (apache#6029)

* [DBACLD-143918] Write developer documentation for the DMN implementation - WIP

* [DBACLD-143918] Write developer documentation for the DMN implementation - WIP

* [DBACLD-143918] Write developer documentation for the DMN implementation - WIP

* [DBACLD-143918] Write developer documentation for the DMN implementation - WIP

* [DBACLD-143918] Write developer documentation for the DMN implementation

* [incubator-kie-issues#1395] Add puml explanation to main README.md

* [incubator-kie-issues#1395] Expand guide as per PR suggestion

---------

Co-authored-by: Gabriele-Cardosi <[email protected]>
rodrigonull pushed a commit to rodrigonull/incubator-kie-drools that referenced this pull request Oct 7, 2024
… implementation (apache#6029)

* [DBACLD-143918] Write developer documentation for the DMN implementation - WIP

* [DBACLD-143918] Write developer documentation for the DMN implementation - WIP

* [DBACLD-143918] Write developer documentation for the DMN implementation - WIP

* [DBACLD-143918] Write developer documentation for the DMN implementation - WIP

* [DBACLD-143918] Write developer documentation for the DMN implementation

* [incubator-kie-issues#1395] Add puml explanation to main README.md

* [incubator-kie-issues#1395] Expand guide as per PR suggestion

---------

Co-authored-by: Gabriele-Cardosi <[email protected]>
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.

Write developer documentation for the DMN implementation
5 participants