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

Update element template docs #2723

Closed
Tracked by #2640
pinussilvestrus opened this issue Feb 1, 2022 · 1 comment · Fixed by #2789
Closed
Tracked by #2640

Update element template docs #2723

pinussilvestrus opened this issue Feb 1, 2022 · 1 comment · Fixed by #2789
Assignees
Labels
documentation Improvements or additions to documentation element templates

Comments

@pinussilvestrus
Copy link
Contributor

pinussilvestrus commented Feb 1, 2022

What should we do?

On the same run as adding the C8 element templates support, we have to make sure that we update our docs. That includes

  • Update screenshots
  • Add Cloud samples
  • Document the usage of the $schema attribute, mark Cloud templates
  • Add new / update features
    • groups
    • optional properties (only support zeebe:input and zeebe:output
    • "new" entries visible = true
    • Cloud bindings
    • zeebe:taskDefinition
    • zeebe:taskHeader
    • zeebe:input
    • zeebe:output
  • Split up binding docs between Platform and Cloud (cf. Update element templates docs to indicate Platform #2382)
  • Mark error scopes as Platform only

Why should we do it?

Keep things up to date
Child of #2640

@pinussilvestrus
Copy link
Contributor Author

pinussilvestrus commented Feb 24, 2022

Updates after chatting with @MaxTru (24th Feb)

https://miro.com/app/board/uXjVOKUvt2s=/

General

Things to be updated / added

  • Using templates
    • Update template properties to explain both Platform and Cloud
  • Defining template
    • $schema: explain how to mark Cloud template
    • add grouping as feature
    • add optional properties as feature
    • mark error scopes as Platform only
    • add "new" entries visible = true feature
    • add zeebe bindings, split up bindings section in general

@pinussilvestrus pinussilvestrus added ready Ready to be worked on and removed backlog Queued in backlog labels Feb 24, 2022
pinussilvestrus pushed a commit that referenced this issue Feb 28, 2022
Closes #2723

* update `$schema` attribute, required for Camunda Cloud
* update latest supported `$schema` versions
* split up binding docs
* add Camund Cloud bindings
* add optional bindings
* add groups
* add entriesVisible
@bpmn-io-tasks bpmn-io-tasks bot added in progress Currently worked on and removed ready Ready to be worked on labels Feb 28, 2022
pinussilvestrus pushed a commit that referenced this issue Feb 28, 2022
Closes #2723

* update `$schema` attribute, required for Camunda Cloud
* update latest supported `$schema` versions
* split up binding docs
* add Camund Cloud bindings
* add optional bindings
* add groups
* add entriesVisible
pinussilvestrus pushed a commit that referenced this issue Feb 28, 2022
Closes #2723

* update `$schema` attribute, required for Camunda Cloud
* update latest supported `$schema` versions
* split up binding docs
* add Camund Cloud bindings
* add optional bindings
* add groups
* add entriesVisible
@bpmn-io-tasks bpmn-io-tasks bot added needs review Review pending and removed in progress Currently worked on labels Feb 28, 2022
pinussilvestrus pushed a commit that referenced this issue Feb 28, 2022
Closes #2723

* update `$schema` attribute, required for Camunda Cloud
* update latest supported `$schema` versions
* split up binding docs
* add Camund Cloud bindings
* add optional bindings
* add groups
* add entriesVisible
@bpmn-io-tasks bpmn-io-tasks bot removed the needs review Review pending label Feb 28, 2022
pinussilvestrus pushed a commit that referenced this issue Feb 28, 2022
Closes #2723

* update `$schema` attribute, required for Camunda Cloud
* update latest supported `$schema` versions
* split up binding docs
* add Camund Cloud bindings
* add optional bindings
* add groups
* add entriesVisible
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation element templates
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant