Update FEEL reference docs to 1.14 #543
Merged
Conversation
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
* copy FEEL reference docs from the latest FEEL-Scala version
|
@saig0 is there a reason you are copying them over from the FEEL docs? Are there Cloud specific changes? Can we consolidate these so they are only in one place so you only have to update 1 repo? |
Yes. This is the current way 😅 If we update the FEEL engine to a new minor version then we copy the docs from the FEEL repository. Otherwise, the Camunda Cloud docs are not in sync and don't contain the latest changes (i.e. new features). Read more about it here: #136
The FEEL docs themselves are not cloud-specific. But in Zeebe, we use FEEL as the expression language. Every new version may contain new built-in functions or other new features that are available in Zeebe.
In general, it would be nice to just have one repository. But it is not so easy. The FEEL engine is used in several places: in Zeebe as the expression language, in Camunda Platform 7 as expression language for DMN, soon in Zeebe as expression language for DMN, and also if someone uses the FEEL engine outside of the Camunda stack. However, I'm happy to discuss your ideas! |
Now I fully get it 😄 thank you. Let's continue working this way for now and maybe we can revisit in the future when I have a more creative idea. |
|
@christinaausley can I have you do a review of the content in this PR (the new content, you don't have to evaluate all the FEEL documentation at this point)? |
|
@saig0 after @christinaausley reviews can you merge this to |
| @@ -109,7 +109,7 @@ log(10) | |||
|
|
|||
| ## exp() | |||
|
|
|||
| Returns the Euler’s number e raised to the power of number. | |||
| Returns the Euler’s number e raised to the power of number . | |||
There was a problem hiding this comment.
Raised to the power of what number exactly?
| @@ -3,56 +3,105 @@ id: feel-unary-tests | |||
| title: Unary-Tests | |||
| --- | |||
|
|
|||
| Unary-Tests can be used only for input entries of a decision table. They are a special kind of expression with additional operators. The operators get the value of the input expression implicitly as the first argument. | |||
| A unary-tests expression is a special kind of boolean expression. It should be used for the input | |||
There was a problem hiding this comment.
Should this be "unary-test expressions" instead of "unary-tests expression"?
docs/reference/feel/language-guide/language-guide-introduction.md
Outdated
Show resolved
Hide resolved
docs/reference/feel/language-guide/language-guide-introduction.md
Outdated
Show resolved
Hide resolved
|
Hi @saig0, I've made a few comments and pushed a commit with a few changes, including:
Let me know if you have any questions! |
akeller
reviewed
Feb 15, 2022
| // {a:1, b:{c:2}} | ||
| ``` | ||
|
|
||
| ### Get entry/path |
There was a problem hiding this comment.
This title with a special character / does not create an anchor link like you would expect. I would recommend removing the special character like
"Get entry or path" -> get-entry-or-path
Or
"Get entry/path" should resolve to -> get-entrypath
because / is simply ignored in markdown, but may behave differently in Docusaurus.
If you choose the second option, watch the build process when you commit to GitHub to make sure it passes.
There was a problem hiding this comment.
^ This is also the source of your build error on the last commit @christinaausley
There was a problem hiding this comment.
Fixed this in the latest commit!
saig0
commented
Feb 22, 2022
There was a problem hiding this comment.
@christinaausley thank you for your review 👍
I added some comments, especially regarding the admonitions. Please have a look.
After we clarified the comments, I will push the changes upstream to the FEEL project. Otherwise, we would override the changes again with the new version 😅
docs/reference/feel/builtin-functions/feel-built-in-functions-introduction.md
Outdated
Show resolved
Hide resolved
docs/reference/feel/language-guide/feel-expressions-introduction.md
Outdated
Show resolved
Hide resolved
docs/reference/feel/language-guide/language-guide-introduction.md
Outdated
Show resolved
Hide resolved
|
@christinaausley I'm ok with the admonition changes @saig0 is suggesting. I like that he's taking a purposeful approach to using various admonitions. They render really ugly in markdown on GitHub but I believe the styling within Docusaurus makes these look less offensive. Please double check though! |
|
@saig0 Adjusted several admonitions according to your comments. Also corrected the build error. Thank you for the follow up! |
akeller
added a commit
that referenced
this pull request
Apr 11, 2022
* Update config docs for Operate and Tasklist (#598) * docs(operate/tasklist): update paths Related with #433 * docs(operate/tasklist): update roles and ldap description Related with #433 * docs(operate/tasklist): update tasklist roles description Related with #433 * docs(operate/tasklist): update Operate elasticsearch settings description Related with #433 * docs(operate/tasklist): add Tasklist GraphQL schema page Related with #433 * Revert "docs(operate/tasklist): add Tasklist GraphQL schema page" This reverts commit b162ac6. * style(formatting): technical review of documentation * docs(operate/tasklist): use Elasticsearch instead of ELS Related with #433 * docs(operate/tasklist): fix amount of created default users Related with #433 Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * Update FEEL reference docs to 1.14 (#543) * docs(feel): update FEEL reference docs * copy FEEL reference docs from the latest FEEL-Scala version Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * docs(operate/tasklist): add TLS config (#608) * docs(operate/tasklist): add TLS config Related with #606 * style(formatting): technical documentation review Technical/editorial updates, including: - Tightening up table spacing for reading purposes. - Adjusting second line in table reading "Should connection be secure via TLS..." -- Is this what you meant here? - Ensuring complete sentences/period. Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> * docs(operate): Add Operate API access (#649) * docs(operate): add Operate API access - fix table format Related with #616 * Update configuration.md technical documentation review * style(formatting): technical review of existing Concepts documentation (#572) * style(formatting): technical review of existing Concepts documentation * resolving broken links * style(formatting): technical overview of Modeler Components docs (#584) * style(formatting): technical overview of Modeler documentation among Components * resolving broken links * Removing deprecated references (#600) Removing references to zeebe-docker-compose because it is depricated * Added variable propagation in xml (#601) * Fix typo (#603) I think this meant to say 'unary test' * Update public-api.md (#595) * Update public-api.md Corrected spelling error in word comptability * Update public-api.md Rephrasing sentence for clarity. Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> * Document Zeebe Cold Backups (#581) * Document Zeebe Cold Backups * Refer to the backup documentation * Include 1.3 in the update guide overview * Review of the cold backup documentation * Adjust wording of warning about filesystem links Co-authored-by: Nicolas Pepin-Perreault <43373+npepinpe@users.noreply.github.com> * Use more forceful wording for backup guide * Update backups.md technical review with minor comments * Review of the cold backup documentation * add motivation for taking backups * explain why clients need to be considered during downtime * don't use caution admonition to stay consistent with color guidelines Co-authored-by: Nicolas Pepin-Perreault <43373+npepinpe@users.noreply.github.com> Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> * Modified script-task Docu (#604) * Modified script-task docu Fixed variable mapping link & added zeebe script worker community extension. * Variable-mappings links to service task * Linked variable mappings (#605) and added a minor sentence * Updated the variable mappings in send & receive tasks/events (#602) * Updated the variable mappings in send & receive tasks/events * fix broken link * fixed typo * Resolved PR Comments * docs(operate): Update note for critical issue fixed on 1.3.4 (#623) * docs(usage-metrics): Updating usage metrics docs to have sample response (#617) * docs(usage-metrics): Updating usage metrics docs to have sample response * Update usage-metrics.md Technical review. Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> * Check product links on build and link check (#632) * chore: add product links to build docs check * chore: make trailing slash optional for duplicate path redirect * chore: add product links to nightly link checker * chore: fix linkcheck file name * chore: checkout repo in link check workflow * chore: remove invalid http scheme from github action * style(formatting): technical review of APIs and Clients documentation (#627) * Adding best practices (#631) * Adding possibility to render BPMN diagrams with callouts * removed comments * Added "Naming BPMN Elements" * Added "Building Flexibility Into BPMN Models" * Improved BPMN integration and callouts * Added "Creating Readable Process Models" * Improved BPMN integration and callouts * trying to improve callouts * Added "Modeling beyond the happy path" * Initial check-in of "Choosing the DMN hit policy" * added first draft of sizing best practice (missing disk space) * Added C7 sizing BP * weakened benchmark project * switching to lower case headlines * renamed "-bpmn" / "-dmn" to "-assets" folder * Added thumbs-down for BPMN models * added modeling-with-situation-patterns * fixed CSS merge * Added handling-data-in-processes * fixed link * migrated invoking-services-from-the-process as C7 specific BP * migrated connecting-the-workflow-engine-with-your-world from blog post * Iterated over sizing best practice with the latest learnings * Fixed numbers, adjusted to latest learnings * typo * Migrated service-integration-patterns from blog * migrated writing-good-workers * removed outdated CC version warning * converted routing-events-to-processes * Initial convertion of dealing-with-exception, branching out C7-only content * typos * Drafted initial version of dealing-with-exceptions * migrated deciding-about-your-stack-c7 * migrated doing-a-proper-poc * copy edit of creating readable process models and modeling beyond the happy path * adjusted C7 stack and added new community extension * looked through copy edit * technical review of Modeling with Situation Patterns and Naming BPMN Elements * Adjusted to use trailing slashes (bpmn viewer now can handle both) * Fixed usage of trailing slashes * fixing links * fixing links * initial convertion (still needing serious work) * Fixed trailing slash detection in bpmn.js thingy * converted naming-technically-relevant-ids * style(formatting): technical review of building flexibility and choosing hit policy * Converted performance-tuning-camunda-c7 * Added sidebar and overview * Small fixed to prep for copy edit * Small fixed to prep for copy edit * migrated securing C7 * linked to the docs for security * converted operating-camunda-c7 * style(formatting): review of deciding about stack, poc, and naming relevant ids * typo * converted versioning-process-definitions * Converted reporting-about-processes-assets/ * Converted reporting-about-processes-assets/ * Converted reporting-about-processes-assets/ * migrated following-the-customer-success-path integrating estimating-effort * intermediate step for testing * slightly restructured BP content * first draft of new testing bp * Improved testing-process-definitions * style(formatting): technical review of sizing your environment and following the customer success path * converted human task related practices * Fixed problem with BPMN's not getting rendered on page changes (moved initialization to plugin) * fixed broken links * Fixed links * fixed links * fixed links * moved svg images to static assets * fixed links * fixed linked image * Fixed double visualization of bpmns * commented polyglot tests for now * slightly improved C7 wording * added greenfield stack BP for CC * typo * fixed link * adjusted package-lock.json to master version, added missing bp to sidebar * Converted https://camunda.com/best-practices/understanding-process-migration/ * fixed links after fetching upstream changes * Fixed overview and headlines * Fixed DMN file loading (trailing slashes) * adjusted to latest numbers * docs(usage-metrics): Updating usage metrics docs to have sample response (#617) * docs(usage-metrics): Updating usage metrics docs to have sample response * Update usage-metrics.md Technical review. Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> * chore: fix broken internal links * chore: add redirect for best-practices overview page * Moved BPMN models to static/ to make docusaurus happy * docs(best practices): remove extra frontmatter values * Added calculcation exportet from GDocs * docs(best-practices): remove .vscode file Co-authored-by: Bernd Ruecker <bernd.ruecker@camunda.com> Co-authored-by: Bernd Ruecker <mail@berndruecker.io> Co-authored-by: Christina Ausley <christina.ausley@camunda.com> Co-authored-by: Luiz Santana <3302415+santanaluiz@users.noreply.github.com> Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> Co-authored-by: Amara <amara.graham@camunda.com> * style(formatting): technical overview of Zeebe Components docs (#586) * style(formatting): technical overview of Zeebe Components docs * resolving broken link anchor text * resolving broken links * pressed commit too quickly, actually resolving broken links * Update overview.md removing comment * resolving broken link * style(formatting): technical overview of Tasklist Components docs (#594) * style(formatting): technical overview of Tasklist Components docs * added comment * adding dictionary extension notes to gitignore * Merge branch 'master' into technicalreview-tasklist * implementing redirect for faq * style(formatting): technical review of existing Cloud Console docs (#580) * style(formatting): technical review of existing Cloud Console documentation * resolving comments * Update create-cluster-include.md Removing comment. * feat(variable-labeling): Update the documentation so that conflicting… (#624) feat(variable-labeling): Update the documentation so that conflicting variable labeling behaviour is underlined relates to: OPT-5966 * fix(bpmn-js): Load process models in right format * fix(dmn-js): Load DMN models in right format * Unified the variable-mapping description (#615) * Unified the variable-mapping description - business-rule-task - script-tasks - send-tasks * Fixes #1 * Fixex #2 * Technicalreview optimize (#628) * style(formatting): technical review of Optimize documentation * editorial adjustments * adjustinng link reference * incorporating Optimize into the development process (#619) * incorporating Optimize into the development process * adding note on multiprocess templates * adding alerts feature * resolving final comments * fix (best-practices) Adjusted partition count to latest G3-S config * fix(migration guide): Softened language around migration * 609 supporting helm charts (#614) * Updated installation guide for ccsm helm charts - removed old picture and added new one - removed old kind-values.yaml - updated the docu and its structure * Reworking page structure - No "Helm" subfolder - Combined 2x Overviews and Prerequisites - Renamed "Accessing Operate..." to "Accessing Operate and Tasklist..." * Update guide for "Accessing Operate and Tasklist" - Added new pictures for login and dashboard - Removed old pictures - Updated guide and moved network docu * Removed unused assets * style(formatting): technical documentation review * implementing redirects * typo in redirects * resolving links * docs(redirects): small fix * docs(kubernetes): link fix for build errors * Update docs/self-managed/zeebe-deployment/kubernetes/helm/installing-helm.md Co-authored-by: Christopher Zell <zelldon91@googlemail.com> * chore: fix redirects for helm * Content overhaul #1 Resolving Zelldon's comments * Content overhaul #2 * Update docs/self-managed/zeebe-deployment/kubernetes/index.md Co-authored-by: Christopher Zell <zelldon91@googlemail.com> * Content overhaul #3 Co-authored-by: Christina Ausley <christina.ausley@camunda.com> Co-authored-by: Amara <amara.graham@camunda.com> Co-authored-by: Christopher Zell <zelldon91@googlemail.com> Co-authored-by: Sebastian Menski <sebastian.menski@camunda.com> * FIrst documentation for Web Modeler (#620) * docs(web-modeler): rough first update * docs(web-modeler): rename Cloud Modeler to Web Modeler and Camunda Modeler to Desktop Modeler * docs(web-modeler): rewrite launch-cloud-modeler.md page * docs(web-modeler): fix issues that ocurred after rebase * docs(web-modeler): rewrite model-your-first-diagram.md page * docs(web-modeler): rewrite import-diagram.md page * docs(web-modeler): rewrite save-and-deploy.md page * docs(web-modeler): rewrite start-instance.md page * docs(web-modeler): remove model-overview.md page * docs(web-modeler): document project roles and invitation * docs(web-modeler): finish docs for collaboration: folder, share, embed, comment, mention * docs(web-modeler): document milestones and diffing * docs(web-modeler): rewrite utilizing-forms.md page and use updated imgs * docs(web-modeler): rewrite automating-a-process-using-bpmn.md and use updated imgs * docs(web-modeler): rewrite getting-started-orchestrate-microservices.md and use updated imgs * docs(web-modeler): rewrite model-your-first-process.md and use updated imgs * docs(web-modeler): rewrite deploy-your-process-and-start-process-instance.md and use updated imgs * docs(web-modeler): rewrite implement-service-task.md and use updated imgs * docs(web-modeler): update implement-decision-gateway.md page and use updated imgs * docs(web-modeler): add supported browsers and cleanup unused images * docs(web-modeler): add news about web modeler and migration * docs(web-modeler): document canvas tools, real time collaboration and attention grabber * docs(redirects): support modeler rename * docs(redirects): add redirect for cloud modeler overview * docs(redirects): swap order * docs(web-modeler): add bpmn guide to next steps * docs(modeler): link to modeler about in bpmn-primer page * style(formatting): technical review of documentation * merge conflict with rename * docs(web-modeler): resolve review comments Co-authored-by: Amara <amara.graham@camunda.com> Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * Typo (#642) * link typo * chore(desktopModeler): update screenshots (#651) * docs(guides): removing retired whitepaper link Marketing retired the "How to migrate to Camunda" whitepaper so this information is no longer available. * Update badges (#656) * update badges, introduce Cloud only badge * update colors, rename Platform Badge * docs(self-managed): update overview note * style(formatting): technical overview of Operate Components docs (#593) * style(formatting): technical overview of Zeebe Components docs * resolving comments * resolving lingering comments in documentation (#657) * Updates guides for Modeler (#658) * docs(guides): update MO guide for modeler updates * typo on keywords * docs(guides): guide updates including links, keywords Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> Co-authored-by: Thomas Heinrichs <thomas.heinrichs@camunda.com> Co-authored-by: Falko Menge <falko.menge@camunda.com> Co-authored-by: GmGamez <81256346+GmGamez@users.noreply.github.com> Co-authored-by: Ole Schönburg <ole.schoenburg@gmail.com> Co-authored-by: Nicolas Pepin-Perreault <43373+npepinpe@users.noreply.github.com> Co-authored-by: Luiz Santana <3302415+santanaluiz@users.noreply.github.com> Co-authored-by: Sebastian Menski <sebastian.menski@camunda.com> Co-authored-by: Bernd Ruecker <bernd.ruecker@camunda.com> Co-authored-by: Bernd Ruecker <mail@berndruecker.io> Co-authored-by: Christina Ausley <christina.ausley@camunda.com> Co-authored-by: Amara <amara.graham@camunda.com> Co-authored-by: Andromachi Rozaki <42938116+andromaqui@users.noreply.github.com> Co-authored-by: Christopher Zell <zelldon91@googlemail.com> Co-authored-by: Catalina Moisuc <catalina.moisuc@camunda.com> Co-authored-by: Ragnar Nevries <ragnar.nevries@camunda.com> Co-authored-by: Amara Graham <akeller@users.noreply.github.com> Co-authored-by: MaxTru <42800119+MaxTru@users.noreply.github.com> * chore(documentation): Add configuration information for usage of the Optimize Public REST API in CCSM Mode (#663) relates to #OPT-6031 * Update Zeebe requirements to JDK17+ (#681) * add redirect for feel docs * typo * another typo * broken link workaround redirect to existing page on prod to correct build issues. fix before release. * Update .htaccess * 1.4.0 - Zeebe process test (#507) * Move deprecated zeebe-test to new page * Add reference to alternative for deprecated zeebe-test * Add zeebe-process-test to docs * technical writing review of testing and zeebe test * Removed zeebe-test page Zeebe-test was deprecated in 1.3.0 and marked for removal in 1.4.0. With 1.4.0 this page was also planned to be deleted. Therefore there is no point in moving it to a separate page with this change. * Remove zeebe-process-test warning By the time this page will be released (1.4.0) there will be a stable version * Rewrote Zeebe Process Test documentation A lot has been changed since I initially wrote this documentation. This change updates it to the definitive 1.4 version. I have also renamed the page to reflect the title * Update zeebe-process-test.md technical documentation review * Fix broken url * Add zeebe-process-test redirects The java-client/testing page was renamed to java-client/zeebe-process-test. Redirects need to be added to ensure the java-client/testing page navigates to the new page. Co-authored-by: Christina Ausley <christina.ausley@camunda.com> Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> Co-authored-by: Amara <amara.graham@camunda.com> * feat(element-templates): add Feel type closes #699 * docs(theme): branding and renaming main page * chore(element-templates): bump schema version (#704) * chore(element-templates): point to example templates directroy * chore(element-templates): bump schema version * docs(mainpage): center desc text * docs(supported-environments): simplify updates (#694) * docs(supported-environments): simplify updates * Update supported-environments.md added correct optimize / c7 information * docs(chore): rename * docs(chore): link typos * docs(chore): update links to supported env * docs(chore): update links to supported env, last 2 * docs(supported-env): add note on elasticsearch * Update supported-environments.md add optimize 3.3 Co-authored-by: Felix Müller <felix.mueller@camunda.com> * Add meta page (#702) * docs(meta): first commit * style(formatting): technical review Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> * Update Operate and Tasklist docs (#705) * docs(operate): add migration requirement of ingest node Related with #641 * docs(operate): update graphql docs Related with #568 * docs(operate): add graphql schema file as link Related with #596 * docs(operate): move graphql schema in asset folder Related with #596 * docs(operate): use relative path Related with #596 * chore(htaccess): add graphqls mime type and workaround Co-authored-by: Sebastian Menski <sebastian.menski@camunda.com> * Add Micronaut Zeebe Client (#711) * Fix typos (#701) * chore(docs): remove Camunda 7 only tag from external variable ingestion docs (#703) * use mixpanel-europe (#688) * Add Micronaut Zeebe Client * style(formatting): technical documentation review technical documentation review Co-authored-by: Josh Windels <joshua.windels@camunda.com> Co-authored-by: Tim Schuppener <tim.schuppener@camunda.com> Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> * Update internal writing resources (#713) * Fix typos (#701) * chore(docs): remove Camunda 7 only tag from external variable ingestion docs (#703) * use mixpanel-europe (#688) * updating style guide * renaming style guide, cheat sheet, and glossary Co-authored-by: Tobias Schaefer <tobias.schaefer@novatec-gmbh.de> Co-authored-by: Josh Windels <joshua.windels@camunda.com> Co-authored-by: Tim Schuppener <tim.schuppener@camunda.com> * chore(docs): migrate self-managed Optimize documentation for CCSM fro… (#700) * chore(docs): migrate self-managed Optimize documentation for CCSM from IAM to Identity relates to OPT-6066 * Update setup.md Technical review of doc. Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> * ci: add c8 stage workflow * chore: ease transform transitions (#718) * chore: add missing transition for component-block * style(formatting): renaming Camunda Platform to Camunda Platform 7 (#719) * Fix typos (#701) * chore(docs): remove Camunda 7 only tag from external variable ingestion docs (#703) * use mixpanel-europe (#688) * docs(CCSM): add optimize license page doc (#710) * docs(CCSM): add optimize license page doc * style(formatting): technical review technical documentation review Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> * fixed path of DMN models (fixes #709) * Change to the new artifactory domain (#717) Related to INFRA-3183 * style(formatting): renaming Camunda Platform to Camunda Platform 7 in Cloud docs Co-authored-by: Tobias Schaefer <tobias.schaefer@novatec-gmbh.de> Co-authored-by: Josh Windels <joshua.windels@camunda.com> Co-authored-by: Tim Schuppener <tim.schuppener@camunda.com> Co-authored-by: Amara Graham <akeller@users.noreply.github.com> Co-authored-by: Bernd Ruecker <bernd.ruecker@camunda.com> Co-authored-by: Chaima Mansouri <25367434+chaima-mnsr@users.noreply.github.com> * Operate Public API documentation (#712) * docs(operate): add base structure for operate api Related with #538 * docs(operate): add initial text for operate api Related with #538 * docs(operate): revise and format operate api Related with #538 * style(formatting): technical review technical review * style(formatting): minor typo fix minor typo fix * docs(operate): reformulate description of "searchAfter" parameter Related with #538 Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> * chore(desktopModeler): update telemetry docs (#727) * chore(desktopModeler): polish basic tutorial texts (#685) (#724) * Add banner (#720) * add C8 banner * docs(banner): update text * chore(desktopModeler/flags): correct heading (#729) * heading did not match the actual flag * docs(chore): cleanup merge conflicts (#744) * Modeler renaming (#721) * docs(modeler): C8 rename * chore(desktopModeler/telemetry): make executionPlatform wqgeneric * docs(modeler): renaming review changes * docs(modeler): review clarifying connectors and plugins Co-authored-by: Max Tru <maximilian.trumpf@camunda.com> * Update licenses.md (#733) * Update licenses.md Adding section for Operate, Tasklist, Identity, Optimize * style(formatting): technical review technical review * docs(licenses): add links for self-managed Co-authored-by: Amara <amara.graham@camunda.com> Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> Co-authored-by: Amara Graham <akeller@users.noreply.github.com> * 451 new roles and permissions (#723) * chore(desktopModeler): update screenshots to 5.0.0 for BPMN (#737) * feat(element-templates): add `elementType` binding (#746) * Update supported-environments.md (#750) Small typo fix * docs(best-practices): renaming (#752) * Fixed link to community connectors (#745) * docs(concepts): renaming (#753) * docs(operate): renaming (#755) * docs(optimize): renaming (#756) * chore(desktopModeler): change title of deploy diagram page (#751) * Operate: decision usage metric (#748) * docs(operate): document decision instance usage metric * style(formatting): technical review technical review * style(formatting): technical review part 2 technical review part 2 Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> * Update User guide screenshots for Operate (#754) * Update User guide screenshots for Operate * style(formatting): remove resolved inline comment Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * docs(apis-clients): renaming (#759) * docs(zeebe): renaming (#758) * docs(tasklist): renaming (#757) * docs: modeler tracked click events (#740) * docs: modeler tracked click events * chore: indentation fix * style(formatting: technical review technical review Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> * docs(identity): create initial identity documentation (#689) * chore(documentation): Documentation update for sharing in CCSM mode (#732) relates to #OPT-6086 Co-authored-by: Amara <amara.graham@camunda.com> * Replace IAM with Identity in authentication section for Operate and Tasklist (#726) * fix(operate-docs): fix merge issues * docs(operate/tasklist): replace IAM with Identity * docs(operate/tasklist): add link to identity * Optimize opt 6100 (#766) * chore(documentation): Added documentation for scope validation when using Optimize Public API relates to #OPT-6100 * chore(documentation): Addressed issues from review relates to #OPT-6100 * feat: implement user concept page (#762) * Close ZeebeClient in example (closes #574 and #230) (#763) * docs(console): renaming - component, API, & footer (#760) * Documented max payload size (#767) * Documented max payload size (#396) * typo * Update handling-data-in-processes.md * style(formatting): technical review technical review Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> * feat(customer-onboarding-data): Include the data to the demo disribution (#736) * feat(customer-onboarding-data): Include the data to the demo disribution relates to: OPT-6055 * style(formatting): technical review technical review Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> * Move Tasklist API tutorial and overview to apis-clients (#749) * docs(operate/tasklist): move api overview and tutorial of Tasklist * docs(operate/tasklist): restructured Tasklist userguide sidebar * Update docs/apis-clients/tasklist-api/overview.md Co-authored-by: Vinícius Goulart <vinicius.goulart@camunda.com> * docs(operate/tasklist): Use Camunda Platform 8 instead of cloud * docs(operate/tasklist): Add rewrite rules for Tasklist API and userguide overview * docs(operate/tasklist): fix links to cluster docs Co-authored-by: Vinícius Goulart <vinicius.goulart@camunda.com> * Make bpmn quickstart generic (#739) * chore(bpmnQuickstart): remove unused screenshots * chore(bpmnQuickstart): make quickstart modeler agnostic * Given Web and Desktop Modeler co-existence, the quickstart shall be agnostic * chore(bpmnQuickstart): rename to C8 Co-authored-by: Amara Graham <akeller@users.noreply.github.com> Co-authored-by: Amara Graham <akeller@users.noreply.github.com> * chore(desktopModeler/dmn): bring in Camunda 8 (#738) * Also make the guide Modeler agnostic to account for the fact, that Web Modeler now also supports DMN * Refactored installation guide out of Zeebe onto top level (fixes #640 and #670) - still need to cleanup some old docs * Removed old installation resources and fixed build (related to #640) * fixed links * fixed link and added mod-rewrite * Update license.md (#771) add cmaunda platform 7 only badge to license page * Document business rule task with called decision (#661) * docs(bpmn): describe business rule task with called decision Camunda Cloud 1.4 will add support for business rule tasks with a called decision extension element. Existing business rule tasks (using the taskDefinition) still work as expected, but are referred to as alternative task implementation. This is to help users understand the difference when chosing the implementation in the Modeler. All that field does is switch between the `taskDefinition` and `calledDecision` extension elements. The modeler will make the `calledDecision` the default implementation. So it makes sense that the docs takes a similar approach. I've therefore tried to write from the perspective of using the business rule task to evaluate decisions modeled as DMN decision. And I've provided an info box near the top to indicate that an alternative implementation exists as well. Additional effort was made to the order of execution between input mappings, decisionId expression evaluation and decision evaluation, as well as what happens when an incident at the business rule task is resolved. At this time, I've chosen not to document any restrictions we impose on the decisionId (like spaces). We should consider whether documenting this is necessary. I've also chosen not to directly reference the DMN scala engine as the internal decision engine. I think this should be independent from the business rule task. However, the choise of decision engine does impose some limitations as users migrating from Camunda Platform 7 will discover. We should consider where these limitations should be documented. * docs(concepts): add decision to incident cases A decision evaluation can also lead to an incident. Not all cases are documented, but decisions are a major part of Camunda Cloud from 1.4 onwards, and so it makes sense to document this here. * docs: favor camunda platform 8 over camunda cloud * docs: favor job worker impl over alt task impl It makes more sense for the section header to reflect the naming used in the modeler, which talks about a job worker implementation and a dmn decision implementation. * docs: use better job type Since DMN decision is the default implementation, job workers are unlikely to be used to evaluate dmn decisions. The example should therefore reflect an example scenario that uses a job worker. The example xml already used the concept of calculating risk. We can simply improve that example by clarifying the job type. * docs: cleanup notes Not all notes are needed anymore, and the ones that are useful should be made more prominent by using info over note. * docs: favor process instance over execution * docs: favor link over bolding * style(formatting): technical review technical review Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> * docs(zeebe-deployment): add TLS abbreviation (#776) * Final touches on Migration Guide (#761) (#765) * Renaming (#761) * Renamed migration page * docs(guides): renaming & fix build issue w/ URL * docs(guide): no caps in URL * docs(htaccess): correct casing for build issues * resolve build error for camunda platform link Co-authored-by: Amara <amara.graham@camunda.com> Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * Console docs to product links (#770) * updating console products to docs links * renaming console folder and implementing redirect * resolving broken links * resolving link issue * renaming and implementing rename for cloud console api reference Co-authored-by: Amara <amara.graham@camunda.com> * add dmn modeling page to web modeler docs (#747) * add dmn modeling page to web modeler docs * add DMN and Form options to "Launch Web Modeler" page Co-authored-by: Amara <amara.graham@camunda.com> * Document new DeployResource RPC and its usage (#716) * docs(grpc): add DeployResource rpc The DeployResource RPC has been recently introduced and will be available from 8 onwards. It can be used to deploy any resource (e.g. BPMN process files and DMN decision models). In the future, we may support additional resources. This RPC replaces the existing DeployProcess RPC, which is deprecated since 8. * docs(grpc): deprecate DeployProcess rpc The DeployProcess RPC has been deprecated since 8. Users should switch to the more flexible DeployResource RPC. Of course the documentation should describe this. To fit it in this page, a new Deprecated RPCs heading is added. The deprecated RPC has been moved to it and a deprecation note has been added explaining since when it was deprecated and that is has been replaced by the DeployResource RPC. * docs(grpc): remove yaml deprecation note This note existed to inform users of the DeployProcess RPC that the YAML format was deprecated and expected to be removed at some point in the future. This removal has already happened with the release of version 1.0. At that time, this note could've been removed already. As the DeployProcess RPC has now been completely deprecated, and YAMLs haven't been supported for more than a year, it makes sense to remove this note. It is no longer needed. * fix(announcements): re-add removed header PR #338 made some changes to the announcements. It looks like an effort was made to re-order the headers chronologically. However, in doing so, one of the deprecation headers was removed and a line of text was duplicated. This rectifies these changes, by re-adding the header and re-orders the section headers according to the above assumption (chronological order). It also removes the duplicated line. * docs(announcements): deprecate deployprocess rpc The DeployProcess RPC is deprecated since 8. This is documented in the gRPC API documentation, but should also be announced in the announcements. * docs: use zbctl deploy resource Since `zbctl deploy <process>` has been deprecated for removal. Any usage should be replaced by the new `zbctl deploy resource <resource>` * docs(go-client): use newDeployResourceCommand The `newDeployResourceCommand` is the new way to deploy resources. The old way is deprecated for removal and we should not use it in documentation. * docs(java-client): use newDeployResourceCommand Switch from the newDeployCommand to newDeployResourceCommand, as one replaces the other. The newDeployCommand is deprecated for removal and should no longer be used in documentation. * docs(go-client): update getting started to v8 client Updates the getting started go-client guide to use the new v8 go client. It also switches to using the new DeployResource RPC. For this the outputs have been updated by running the steps against a 8.0.0 cluster. * docs(go-client): update quick ref to v8 client Similar to the previous commit, this updates the quick reference to use the new v8 go-client. * docs(grpc): move error handling above deprecated rpcs * Element templates updates (#778) * docs(element-templates): add latest schema versions, icon, and documentationRef Related to bpmn-io/internal-docs#499 * Add DMN reference docs (#775) * feat(dmn): copy DMN reference pages from C7 docs * copy the pages and the images from the C7 DMN reference docs * adjust page headers * fix references and images * remove content for unsupported features * add hints to use names without symbols * refactor(feel): move FEEL docs to components/modeler * align the location of the docs with BPMN and DMN * feat(bpmn): link from business rule task to DMN docs * fix(links): add redirect for previous FEEL docs * the FEEL docs has moved from /reference to /components/modeler * add new redirects for the previous location * fix: updated flags docs with `disable-form` (#779) Closes camunda/camunda-modeler#2767 * Fixed Helm chart repo URL * react-components * docs(release-policy): updates for C8 (#777) * docs(release-policy): updates for C8 * docs(release-policy): add screenshot and final updates * style(formatting): technical review technical review Co-authored-by: Christina Ausley <christina.ausley@camunda.com> Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> * docs(operate/tasklist): add tls connection to zeebe configuration (#787) * Update what-is-camunda-platform-8.md (#788) * Update what-is-camunda-platform-8.md update whats platform 8, input from product marketing * style(formatting): technical review technical review * adding docs links Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * docs(reference): renaming c8 (#790) * cross linking between guides and concepts (#785) * cross linking between guides and concepts * typo adjustment typo adjustment Co-authored-by: Amara Graham <akeller@users.noreply.github.com> * docs(pages): renaming c8 (#791) * Added Identity requirements and harmonized installation description (#781) * Added Identity requirements and harmonized installation description (closes #772) * fixed sidebar target * Update docs/reference/supported-environments.md Co-authored-by: dlavrenuek <20122620+dlavrenuek@users.noreply.github.com> * fixed id * fixed internal link * fixed links * fixed htaccess * docs(platform-deployment): typos * docs(platform-deployment): update components list * workaround for redirects like #697 * docs(htaccess): fix redirect * docs(htaccess): remove trailing slash * removing slash to maybe fix build issue * one more meager attempt at fixing htaccess to resolve build * docs(htaccess): rework redirects * redirects like #697 * final fixes * style(formatting): technical review Co-authored-by: dlavrenuek <20122620+dlavrenuek@users.noreply.github.com> Co-authored-by: Amara <amara.graham@camunda.com> Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * Optimize 3.8 update (#789) * chore(import): adjust import api response related to OPT-5883 * chore(optimize): Remove support for Elasticsearch 7.8.0/7.9.0 relates to: OPT-5865 * chore(objectVars): add native JSON var support to docs related to OPT-5903 * feat(variable-label): docs for public api endpoint relates to: OPT-5847 * chore(optimize): note about bug in decision variable import in 3.7.0/1 relates to OPT-5949 * chore(optimize): support for Elasticsearch 7.17.0 relates to #OPT-6039 * chore(optimize): Documentation for Public API changes in Platform mode relates to #OPT-6031 * chore(issues): add note about empty string prop on object vars related to OPT-6047 * chore(optimize): Sharing Enable/Disable API Endpoints documented relates to #OPT-6086 * chore(optimize): document es pathprefix config related to OPT-6091 * chore(optimize): scope-based authentication in platform or CCSM mode relates to #OPT-6100 * chore(optimize): remove cambpm 7.14 support and add 7.17 relates to OPT-6040 * chore(optimize): 3.8.0 localization information * chore(optimize): update dependency files for 3.8 * docs(htaccess): add diff file type * style(formatting): technical review and htaccess fix Co-authored-by: Amara <amara.graham@camunda.com> Co-authored-by: Christina Ausley <christina.ausley@camunda.com> Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> * Fixed links to migration tooling * docs(guides): renaming c8 (#792) * docs(guides): renaming c8 * drop C8 and Cloud from Console * docs(exporters): move to self-managed (#786) * adjusting minimum version requirement (#795) * docs(self-managed): renaming C8 (#796) * docs(root): renaming c8 (#798) * update Slack inviter link (#799) * docs(footer): update Slack link * Connectors docs (#725) * scaffold conncetors docs * chore(connectors): document managing secrets * chore(connectors): document the SendGrid connectors w/o template * chore: manage secrets to console section * chore(connectors): document the Rest Connector * chore(connectors): document the available connectors * chore(connectors): add intro and usage section * Update docs/components/modeler/web-modeler/connectors/use-connectors.md Co-authored-by: Amara Graham <akeller@users.noreply.github.com> * style(formatting): technical review * chore(connectors): apply review comments Co-authored-by: Catalina Moisuc <catalina.moisuc@camunda.com> Co-authored-by: Amara <amara.graham@camunda.com> Co-authored-by: Amara Graham <akeller@users.noreply.github.com> Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * adjust and implement C7 links (#800) * adjust and implement C7 links * resolving comment with updated connectors docs Co-authored-by: Ralf Puchert <49151958+ralfpuchert@users.noreply.github.com> Co-authored-by: Christina Ausley <christina.ausley@camunda.com> Co-authored-by: Philipp Ossler <philipp.ossler@gmail.com> Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> Co-authored-by: Thomas Heinrichs <thomas.heinrichs@camunda.com> Co-authored-by: Falko Menge <falko.menge@camunda.com> Co-authored-by: GmGamez <81256346+GmGamez@users.noreply.github.com> Co-authored-by: Ole Schönburg <ole.schoenburg@gmail.com> Co-authored-by: Nicolas Pepin-Perreault <43373+npepinpe@users.noreply.github.com> Co-authored-by: Luiz Santana <3302415+santanaluiz@users.noreply.github.com> Co-authored-by: Sebastian Menski <sebastian.menski@camunda.com> Co-authored-by: Bernd Ruecker <bernd.ruecker@camunda.com> Co-authored-by: Bernd Ruecker <mail@berndruecker.io> Co-authored-by: Andromachi Rozaki <42938116+andromaqui@users.noreply.github.com> Co-authored-by: Christopher Zell <zelldon91@googlemail.com> Co-authored-by: Catalina Moisuc <catalina.moisuc@camunda.com> Co-authored-by: Ragnar Nevries <ragnar.nevries@camunda.com> Co-authored-by: MaxTru <42800119+MaxTru@users.noreply.github.com> Co-authored-by: grlimacan <91879848+grlimacan@users.noreply.github.com> Co-authored-by: Remco <remco@westerhoud.nl> Co-authored-by: Martin Stamm <martin.stamm@camunda.com> Co-authored-by: Felix Müller <felix.mueller@camunda.com> Co-authored-by: Tobias Schaefer <tobias.schaefer@novatec-gmbh.de> Co-authored-by: Josh Windels <joshua.windels@camunda.com> Co-authored-by: Tim Schuppener <tim.schuppener@camunda.com> Co-authored-by: Chaima Mansouri <25367434+chaima-mnsr@users.noreply.github.com> Co-authored-by: Beatriz Mendes <bea.smendes98@gmail.com> Co-authored-by: Max Tru <maximilian.trumpf@camunda.com> Co-authored-by: Svetlana Dorokhova <sveta_d@list.ru> Co-authored-by: huygur <45518829+huygur@users.noreply.github.com> Co-authored-by: Valentin Serra <serval.core@gmail.com> Co-authored-by: Ben Sheppard <Ben-Sheppard@users.noreply.github.com> Co-authored-by: Vinícius Goulart <vinicius.goulart@camunda.com> Co-authored-by: Nico Korthout <korthout@users.noreply.github.com> Co-authored-by: Sebastian Stamm <sebastian.stamm@camunda.com> Co-authored-by: Niklas Kiefer <niklas.kiefer@camunda.com> Co-authored-by: Valentin Serra <valentin.serra@camunda.com> Co-authored-by: dlavrenuek <20122620+dlavrenuek@users.noreply.github.com> Co-authored-by: Sebastian Bathke <sebastian.bathke@camunda.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In Zeebe version
1.4.0, we updated the version of FEEL-Scala to1.14.1(camunda/camunda#8513).This PR copies the latest version of the FEEL docs (https://camunda.github.io/feel-scala/docs/1.14/reference/) in the Camunda Cloud docs. The docs are not modified to keep them in sync with the original docs in the FEEL-Scala repository (related to #136).