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

I can read how to model a DMN #422

Closed
Tracked by #8083
saig0 opened this issue Nov 1, 2021 · 14 comments
Closed
Tracked by #8083

I can read how to model a DMN #422

saig0 opened this issue Nov 1, 2021 · 14 comments
Labels
component:docs Documentation improvements, including new or updated content component:zeebe Issues related with Zeebe project kind/feature Issues related with features to be documented

Comments

@saig0
Copy link
Member

saig0 commented Nov 1, 2021

With Zeebe 1.3, we implement that a business rule task can evaluate a DMN decision.

We should add a new section to the reference for DMN. It should describe what parts of DMN are supported, how to use a decision table, and how to use a literal expression.

It may look similar to https://docs.camunda.org/manual/7.16/reference/dmn/. Since Zeebe uses a different DMN engine, we can't copy the content completely.

We need to think about where to store the documentation. The FEEL docs are located in the FEEL-Scala project and are copied into the docs. For DMN it is kind of similar because we will share the same DMN engine with Camunda Platform 7.

@saig0 saig0 added the component:zeebe Issues related with Zeebe project label Nov 1, 2021
@akeller
Copy link
Member

akeller commented Nov 29, 2021

@christinaausley's tasked with creating a platform agnostic guide for DMN which will likely cover "how to use a decision table". When this is closer to being complete on the engineering side, can you sync with us on how to document this experience?

@saig0
Copy link
Member Author

saig0 commented Dec 7, 2021

@akeller just to make it clear, who should write the documentation for DMN? the engineering team? what is the concrete task of @christinaausley?

@akeller
Copy link
Member

akeller commented Dec 7, 2021

We are moving Modeler documentation from docs.camunda.org to docs.camunda.io, which will include DMN but will be marked "Platform-only". You can see that work on #415.

@christinaausley will work on drafting guides for BPMN, DMN, and forms reusing some existing content. These guides will be agnostic if possible, meaning they should apply to both Cloud and Platform where possible.

The engineering team should plan to write the rest of the DMN documentation, including reviewing the DMN guide to make sure functionality added to Cloud works as documented.

@saig0
Copy link
Member Author

saig0 commented Dec 8, 2021

@akeller thank you for the information 👍

When can we expect the agnostic DMN documentation from @christinaausley?
We want to launch DMN in Camunda Cloud with version 1.4 (end of Q1 2022). For the release, we should have a DMN doc for the users.

@menski menski added kind/feature Issues related with features to be documented release/1.4.0 labels Dec 16, 2021
@akeller
Copy link
Member

akeller commented Dec 17, 2021

That should be in line with what @christinaausley can do 🙂

@korthout
Copy link
Member

korthout commented Feb 3, 2022

Ping @barmac, just to keep you in the loop

@akeller
Copy link
Member

akeller commented Feb 18, 2022

Recapping a meeting we had this morning led by @saig0 with myself, @korthout, @christinaausley and @barmac:

@korthout korthout linked a pull request Feb 22, 2022 that will close this issue
@barmac
Copy link
Contributor

barmac commented Feb 28, 2022

Probably this is not part of this issue, but it's related to the DMN documentation. At camunda.com, user can download a DMN Cheatsheet. The cheatsheet is Camunda DMN-specific, e.g.
image
or
image

Perhaps it makes sense to update the cheatsheet once DMN is supported in the Cloud.

@santanaluiz
Copy link
Contributor

@akeller is the DevRel team planning to create any documentation about Operate usage as well?

@akeller
Copy link
Member

akeller commented Feb 28, 2022

@akeller is the DevRel team planning to create any documentation about Operate usage as well?

@santanaluiz In terms of DMN?

I have nothing in the DX backlog, but @Hafflgav or @jwulf do either of you have plans for official or unofficial docs for Operate?

@akeller
Copy link
Member

akeller commented Feb 28, 2022

Probably this is not part of this issue, but it's related to the DMN documentation. At camunda.com, user can download a DMN Cheatsheet. The cheatsheet is Camunda DMN-specific, e.g. image or image

Perhaps it makes sense to update the cheatsheet once DMN is supported in the Cloud.

@barmac can you link me to this cheatsheet? I can work with the marketing team to update it.

@barmac
Copy link
Contributor

barmac commented Mar 1, 2022

Sure, it's available at https://page.camunda.com/wp-dmn-cheat-sheet

@Hafflgav
Copy link

Hafflgav commented Mar 1, 2022

@akeller & @santanaluiz - so far I also have no plans about any docs for Operate.
But it might be a good idea to overhaul the cheat sheet you have posted... ;)

@akeller akeller added the component:docs Documentation improvements, including new or updated content label Apr 25, 2022
@saig0
Copy link
Member Author

saig0 commented Apr 27, 2022

Done by #775

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation improvements, including new or updated content component:zeebe Issues related with Zeebe project kind/feature Issues related with features to be documented
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants