-
Notifications
You must be signed in to change notification settings - Fork 185
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
docs(optimize): update task analysis docs #3044
Conversation
related to OPT-7387
@misiekhardcore we don't have a link to that Optimize ticket, so I'm not sure when we should merge and plan to release this change. Is this something that is going live in the Jan minor release? |
Hey, @akeller, here is the optimzie ticket for this. These changes are going to be a part of 8.4 release, yes :) |
I am going to place a |
@christinaausley I had to update few things |
@misiekhardcore Are you comfortable merging this into |
@christinaausley yes |
👋 🤖 🤔 Hello! Did you make your changes in all the right places? These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.3/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
* docs(optimize): update task analysis docs related to OPT-7387 * style(formatting): technical review * final task analysis adjustments --------- Co-authored-by: Christina Ausley <christina.ausley@camunda.com> Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com>
#3042) * docs(identity): add new environment variable for components' client id * Update configuration-variables.md * document deployment enabled functionality (#3038) * Update screenshot of Play to contain the restart process button and improve instruction (#3018) * add known issue for keycloak (#3037) * add known issue for keycloak * update versioned docs * docs(connectors): added guide to run custom connectors in helm (#3036) * docs(connectors): added guide to run custom connectors in helm * chore(connectors): custom connectors in helm charts guide * fix(connectors): fix broken link * fix(connectors): fix repetitive statement * style(formatting): technical review --------- Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * feat: Operate OpenAPI explorer (part 2) (#2944) * prototype: configure a single-version docs instance for the operate OpenAPI explorer * prototype: add Operate API Explorer to APIs & Clients top-nav item * prototype: extend NavbarItem to display Operate OpenAPI docs plugin version in navbar * prototype: configure openapi explorer for operate API and generate some pages * prototype: add verb badges to openapi explorer * prototype: scrub the URL from my cluster (I think) * prototype: add link to operate api explorer from existing operate api docs * prototype: noindex this site so I can deploy it as a preview * Remove extra lines It makes me ridiculously happy to be able to do these prettier updates through the GitHub UI. Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Remove outdated comment * feedback: revert top nav to remove API explorer direct link * fix: put child objects on the same line as their summary/details expander * refactor: extract Authentication to its own doc * refactor: remove content superseded by api explorer * refactor: lead with the api explorer * refactor: remove unused operate api intro page (and change entrypoint into api explorer) * customize sample languages * add an 'internal link' indicator in sidebar * add a backlink to explorer sidebar * update sidebar links for 8.3 and 8.2 * feat: add borders to (almost all) tab buttons that are missing them * feat: copy next operate-api structure changes to 8.3 * chore: fix URLs * feat: add scripts for generating OpenAPI interactive explorers * docs: on the interactive API explorers * style(formatting): technical review * feedback: Title Case for API Explorer * feedback: nudge on code languages --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * feat(connectors): added note on OData support (#3046) * feat(connectors): added note on OData support * style(formatting): technical review --------- Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * fix(connectors): typo in the inbound project outline (#3055) * feat(self-managed): add note about tenant ID (#3056) Related to camunda/camunda-modeler#3966 * Update local-kubernetes-cluster.md, wrong command for switching the context (#3050) Documentation shows the wrong command for switching the context using `kubectl`: `kubectl cluster-info --context kind-camunda-platform-local` It should be: `kubectl config use-context kind-camunda-platform-local` However, if you create the cluster using `kind` just shortly before, the context will be switched automatically to the new cluster. * backport to 8.1-8.3 (#3060) * fix broken markdown links (#3062) Links were referencing invalid file paths * Added table about message correlation (#2960) * added table about message correlation * style(formatting): technical review * inverted < to > * added 'the' * clarified why message name can be omitted * linked to message uniqueness for equal message * backported --------- Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * clean up authorization references (#2925) * clean up authorization references * fix links * fix redirect * build out authentication sections * update links * update more links * try next redirect * add slash * remove current redirect --------- Co-authored-by: Amara <amara.graham@camunda.com> * feat(supportedEnvs): add AWS OS 2.5 support note (#3063) * feat(supportedEnvs): add AWS OS 2.5 support note * related to camunda/product-hub#997 * Update supported-environments.md --------- Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> * improvement: instead of indexing everything and turning it off for staging, index nothing and turn it on for production. (#3068) * Add 8.4 update guide (#3005) * add 8.4 update guide * add update guide to sidebars * add to optimize sidebars * backport optimize link fix (#3071) * chore: add user restrictions section (#3043) * add user restrictions section * Update sidebars.js * Update user-restrictions.md * Update optimize_sidebars.js * adjust sidebar * style(formatting): technical review * Update sidebars.js Co-authored-by: Christian Konrad <56470362+christian-konrad@users.noreply.github.com> * Update optimize_sidebars.js Co-authored-by: Christian Konrad <56470362+christian-konrad@users.noreply.github.com> * Update docs/self-managed/tasklist-deployment/tasklist-authentication.md Co-authored-by: Christian Konrad <56470362+christian-konrad@users.noreply.github.com> * Update docs/self-managed/concepts/access-control/user-restrictions.md Co-authored-by: Christian Konrad <56470362+christian-konrad@users.noreply.github.com> * Update docs/self-managed/concepts/access-control/user-restrictions.md Co-authored-by: Christian Konrad <56470362+christian-konrad@users.noreply.github.com> * Update docs/self-managed/identity/deployment/configuration-variables.md Co-authored-by: Christian Konrad <56470362+christian-konrad@users.noreply.github.com> * Update docs/self-managed/concepts/access-control/user-restrictions.md Co-authored-by: Christian Konrad <56470362+christian-konrad@users.noreply.github.com> * Update docs/self-managed/concepts/access-control/user-restrictions.md Co-authored-by: Christian Konrad <56470362+christian-konrad@users.noreply.github.com> * Update docs/self-managed/concepts/access-control/user-restrictions.md Co-authored-by: Christian Konrad <56470362+christian-konrad@users.noreply.github.com> * Update docs/self-managed/concepts/access-control/user-restrictions.md Co-authored-by: Christian Konrad <56470362+christian-konrad@users.noreply.github.com> * Update docs/self-managed/concepts/access-control/user-restrictions.md Co-authored-by: Christian Konrad <56470362+christian-konrad@users.noreply.github.com> * Update docs/self-managed/concepts/access-control/user-restrictions.md Co-authored-by: Christian Konrad <56470362+christian-konrad@users.noreply.github.com> * Update docs/self-managed/concepts/access-control/user-restrictions.md Co-authored-by: Christian Konrad <56470362+christian-konrad@users.noreply.github.com> * Update docs/self-managed/concepts/access-control/user-restrictions.md Co-authored-by: Christian Konrad <56470362+christian-konrad@users.noreply.github.com> * Update docs/self-managed/concepts/access-control/user-restrictions.md Co-authored-by: Christian Konrad <56470362+christian-konrad@users.noreply.github.com> * Update docs/self-managed/tasklist-deployment/tasklist-authentication.md Co-authored-by: Christian Konrad <56470362+christian-konrad@users.noreply.github.com> * Add code review changes * Update user-task-access-restrictions.md --------- Co-authored-by: Christina Ausley <christina.ausley@camunda.com> Co-authored-by: Christian Konrad <56470362+christian-konrad@users.noreply.github.com> Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> Co-authored-by: Amara Graham <akeller@users.noreply.github.com> * revert 2944 (Operate API Explorer) and cry (#3072) * Fix tasklist stringfy request (#3045) * resolve web modeler api sidebar (#3074) * resolve web modeler api sidebar * add overview slug * fix optimize sidebar * adjust links * add slash * one more try * adjust links per steve * oops made a fix * update 8.2 - current docs (#3070) * fix(announcements): fix indentation (#3083) * remove IAM admonition (#3077) * self managed review (#3057) * self managed review * operate changes * tasklist changes * fix link * resolve comments * docs(web-modeler): start forms in self-managed (#3066) * docs(web-modeler): start forms in self-managed * syle(formatting): technical review * docs(web-modeler): technical review * chore(web-modeler): remove unused SelectStartEventImg --------- Co-authored-by: Christina Ausley <christina.ausley@camunda.com> Co-authored-by: Wolfgang Amann <wolfgang.amann@camunda.com> * Update Process Instance Migration concept for 8.4 release (#3064) * docs: Update Process Instance Migration concept for 8.4 release Removed the danger banner because it will be fixed in Zeebe with PR camunda/camunda#15621 * docs: Update Operate's Process Instance Migration concept for 8.4 release Removed the danger banner because it will be fixed in Zeebe with PR camunda/camunda#15621 * docs(operate): show bpmn process in screenshots (#3085) * Add multi-tenancy to C7 migration guide (#3075) * add mt section to next * backport to 8.3 * resolve comments * Update docs/guides/migrating-from-camunda-7/conceptual-differences.md Co-authored-by: Nikola Koevski <nikola.koevski@camunda.com> * Update versioned_docs/version-8.3/guides/migrating-from-camunda-7/conceptual-differences.md Co-authored-by: Nikola Koevski <nikola.koevski@camunda.com> --------- Co-authored-by: Christina Ausley <christina.ausley@camunda.com> Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> Co-authored-by: Nikola Koevski <nikola.koevski@camunda.com> * fix: added helm equivalent values for env vars for generic oidc provider (#3073) * fix: added helm equivalent values for env vars for generic oidc provider * style(formatting): technical review --------- Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * self managed architecture and deployment review (#3015) * self managed architecture and deployment review * remove comments * feat(announcements): create clarity of OS support (#3079) * feat(announcements): create clarity of OS support * Co-authoted by Johan * Update announcements.md * add link * add note to relevant pages --------- Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * docs(self-managed): unify example deployment name (#3065) * docs(ootbc): improve sqs connector docs (#3097) * docs(optimize): update screenshots (#3082) * adjust doc card length and descriptions (#3059) * some meaningless change * feat: allow for custom descriptions on cards Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * update optimize description * run prettier * update css for line clamp woohoo --------- Co-authored-by: Steven Hicks <steven.hicks@camunda.com> * docs(webhook): Document webhook correlation result (#3098) * feat(updateGuides): add note for supported environments (#3087) * docs(oidc): Connectors warning regarding OIDC (#3099) * docs(oidc): Connectors warning regarding OIDC * adjust link --------- Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * add zeebe auth intructions (#3117) * chore(tasklist): Update Tasklist configuration files locations (#3118) * chore(tasklist): Update Tasklist configuration files locations * Update versioned_docs/version-8.1/self-managed/tasklist-deployment/tasklist-configuration.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update versioned_docs/version-8.1/self-managed/tasklist-deployment/tasklist-configuration.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * run prettier --------- Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * Add update job timeout docs (#3081) * api-tools(grpc): adding documentation for UpdateJobTimeout RPC * concepts(job workers): adding documentation for timeout update * concepts(job workers): changing the formatting Changing formatting to use bullet points * style(formatting): technical review --------- Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * fix: aws marketplace fixes required before publishing (#3120) * docs: document boundary events migration limitation (#3094) * docs: document boundary events migration limitation * docs: update process instance migration limitations * docs: document grpc response for unauthorized tenant * style(formatting): add periods --------- Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * feat(pim): deeplink limitations (#3124) * fix(web-modeler): fix rewrite rule for user task linking (#3123) * docs(modeler): link default execution platform version flag (#2948) * docs(zeebe): update cluster scaling docs (#3125) * docs(zeebe): update cluster scaling docs * docs(zeebe): document dryRun for scaling api * style(formatting): technical review --------- Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * docs(connectors): explained several fields (#3102) * docs(connectors): explained several fields * applied PR comments * style(formatting): technical review --------- Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * console: HEAD requests need to be accepted for alert-webhooks (#3142) * docs(operate): depdency version updates (#3139) * docs(self-managed): fix c8sm architecture diagram combined ingress * adjust camunda apps UI (#3113) * docs(web-modeler): generic oidc provider support for Web Modeler (#3041) * docs(web-modeler): generic oidc provider support for Web Modeler * Update connect-to-an-oidc-provider.md * docs(web-modeler): use new env vars, cross-link entra id section --------- Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> * docs(concepts): rm reverted event migration section (#3144) Process instance migration can no longer deal with event subscriptions. While this is documented in the limitations with some specific scenarios, it should also be clear in the rest of the concept documentation. So, this removes the section discussing event subscriptions because it implies behavior that is not available. I've also clarified the case where an active service task receives a boundary event in the target process definition which is also not supported at this time. It could be implied from the rule above it, but I'd rather have the limitations be explicit. * docs(helm): Add OpenSearch note (#3145) * docs(helm): Add OpenSearch note * style(formatting): technical review --------- Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * chore(docs): remove identity dependency from Optimize support environments (#3088) * feat: Suggest missing changes across current/next versions (#3091) * feat: initial check-versions implementation * feat: don't create a version comparison comment if nothing was ever wrong * small language changes * initial re-design: walking skeleton * finished walking skeleton, with things in a folder * add some ligaments to the skeleton. Still connecting things, but it looks more like real life * green tests * refactor: a little better implementation still not sure if * tests: identify missing changes * build messages * feat: build messages for all suggested changes * feat: copy steps to check-versions workflow * chore: remove temporary workflow * oops: remove a version suggestion from the configuration that I'm not ready for * fix: update method of writing to output * fix: remove quotes, will this really work? * ???? throwing darts at this point * more darts ???? * fix, I think: write everything to github_env instead of github_output * docs(self-managed): fix c8sm architecture diagram combined ingress * docs(self-managed): add multi-namespace deployment guide (#3122) * docs(self-managed): add multi-namespace deployment guide * style(formatting): technical review * rewording * add guide to sidebars --------- Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * docs(optimize): create migration guide for 3.12 (#3058) * docs(optimize): create migration guide for 3.12 * style(formatting): technical review * chore(docs): clarified removal of 8.8 support * update translation diff * update translation diff --------- Co-authored-by: Christina Ausley <christina.ausley@camunda.com> Co-authored-by: Josh Windels <joshua.windels@camunda.com> * docs(forms): Add dynamic list section and clean up iframe section (#3138) * feat: document dynamic list and related features Related to bpmn-io/form-js#796 * fix: iframe text spacing and closing note * style(formatting): technical review --------- Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * chore(optimize): update third party dependencies for 3.12 (#3149) * docs(web-modeler): dependency updates for recent releases (#3157) * docs(ingress-nginx): correct nginx mentionings and replace NGINX Ingress usage (#3147) * docs(ingress-setup): replace NGINX Ingress for ingress-nginx * docs(openshift): explicitly mention that ingress-nginx is used by Camunda and NGINX requires extra work * docs(various): align ingress-nginx mentionings * docs(openshift): add grpc example for NGINX Ingress * docs(various): clarify remaining nginx namings * docs(self-managed): updates for release cycle v8.4 (#3084) * update-guide change * Update docs/self-managed/operational-guides/update-guide/830-to-840.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * updated announcements * modified sentence * added more to the upgrade guide * added compose * added list of potential breaking changes * style(formatting): technical review * update helm chart versioning info * update upgrade instructions for c8 helm 9.0.0 * use artifacthub for helm docs * use artifacthub for helm docs --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Christina Ausley <christina.ausley@camunda.com> Co-authored-by: Ahmed AbouZaid <6760103+aabouzaid@users.noreply.github.com> * docs(optimize): update task analysis docs (#3044) * docs(optimize): update task analysis docs related to OPT-7387 * style(formatting): technical review * final task analysis adjustments --------- Co-authored-by: Christina Ausley <christina.ausley@camunda.com> Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> * docs(web-modeler):document zeebe client configuration (#3096) * docs(web-modeler):document zeebe client configuration * remove version prefix from links * add gh and postman links to docs (#3121) * Update Zeebe security docs to highlight PKCS1 support (#3146) * doc: Update Zeebe security docs to highlight PKCS1 support * style(formatting): technical review --------- Co-authored-by: Christina Ausley <christina.ausley@camunda.com> * connectors and optimize sm docs review (#3119) * connectors and sm docs review * resolve comments * fix: prevent large images from stretching locally (#3154) * chore: synchronize sidebars for v8.1/3.9.0 (#3153) * chore: sync sidebars (v8.1, components, docs -> optimize) * chore: sync sidebars (v8.1, self-managed, docs -> optimize) * [BLOCKED] feat: Add script to update version configuration of check-versions workflow when cutting a new version (#3116) * feat: initial check-versions implementation * feat: don't create a version comparison comment if nothing was ever wrong * small language changes * initial re-design: walking skeleton * finished walking skeleton, with things in a folder * add some ligaments to the skeleton. Still connecting things, but it looks more like real life * green tests * refactor: a little better implementation still not sure if * tests: identify missing changes * build messages * feat: build messages for all suggested changes * feat: copy steps to check-versions workflow * chore: remove temporary workflow * oops: remove a version suggestion from the configuration that I'm not ready for * fix: update method of writing to output * fix: remove quotes, will this really work? * ???? throwing darts at this point * more darts ???? * fix, I think: write everything to github_env instead of github_output * feat: add automated step to versioning process, to update version configuration for check-versions workflow * Move unexpected MT behavior to troubleshooting sections (#3048) * pairing commit * add details for tasklist and optimize * adjust optimize links * separate into troubleshooting section * operate tweak * backport * fix optimize links * fix a couple more links --------- Co-authored-by: Christina Ausley <christina.ausley@camunda.com> Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> * link tenants and multi tenancy docs (#3103) * cookie to bearer changes (#3115) * adjust camunda apps UI * cookie to bearer in tasklist * oops * oops again * backport and resolve comment * adjust curl * chore: synchronize sidebars for v8.2/3.10.0 (#3160) * chore: sync sidebars (v8.2, components, docs -> optimize) * chore: sync sidebars (v8.2, self-managed, docs -> optimize) * Expand api sidebars (#3150) * console adjustments * adjust optimize and zeebe * remove redirects remove redirects * fix the build plz * Update docs/apis-tools/zeebe-api/deprecated-rpcs.md Co-authored-by: Steven Hicks <steven.j.hicks@gmail.com> * fix a couple links * tweak a couple things * nvm that was a mistake * push optimize fix * adjust to overview thnx steve * fix href and docid * remove next from versioned docs links --------- Co-authored-by: Steven Hicks <steven.j.hicks@gmail.com> * docs(identity): apply review comments --------- Co-authored-by: maryam.nematigavzan <maryam.nematigavzan@camunda.com> Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> Co-authored-by: Hüsna Uygur <45518829+huygur@users.noreply.github.com> Co-authored-by: Igor Petrov <108870003+igpetrov@users.noreply.github.com> Co-authored-by: Christina Ausley <christina.ausley@camunda.com> Co-authored-by: Steven Hicks <steven.j.hicks@gmail.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Pavel Kotelevsky <38818382+chillleader@users.noreply.github.com> Co-authored-by: Philipp Fromme <philippfromme@outlook.com> Co-authored-by: Adam Boczek <adam.boczek@nttdata.com> Co-authored-by: Amara Graham <akeller@users.noreply.github.com> Co-authored-by: Tim Stawowski <t.stawows@gmail.com> Co-authored-by: Jonathan Lukas <jonathan.lukas@camunda.com> Co-authored-by: Amara <amara.graham@camunda.com> Co-authored-by: MaxTru <42800119+MaxTru@users.noreply.github.com> Co-authored-by: Nathanyel Sandi <nathan.sandi@gmail.com> Co-authored-by: Christian Konrad <56470362+christian-konrad@users.noreply.github.com> Co-authored-by: Valentino Pellegrino <valentino.pellegrino@camunda.com> Co-authored-by: Wolfgang Amann <wolfgang.amann@camunda.com> Co-authored-by: berkaycanbc <124141078+berkaycanbc@users.noreply.github.com> Co-authored-by: Patrick Dehn <pedesen@users.noreply.github.com> Co-authored-by: Nikola Koevski <nikola.koevski@camunda.com> Co-authored-by: Jesse Simpson <jesse.simpson@camunda.com> Co-authored-by: Ahmed AbouZaid <6760103+aabouzaid@users.noreply.github.com> Co-authored-by: Oleksii Ivanov <108869886+Oleksiivanov@users.noreply.github.com> Co-authored-by: Michał Konopski <58469680+misiekhardcore@users.noreply.github.com> Co-authored-by: Steven Hicks <steven.hicks@camunda.com> Co-authored-by: Simon <sbuettner@users.noreply.github.com> Co-authored-by: Houssain Barouni <146710021+houssain-barouni@users.noreply.github.com> Co-authored-by: Ana <148554252+ana-vinogradova-camunda@users.noreply.github.com> Co-authored-by: Abbas Adel Ibraim <abbasadel@users.noreply.github.com> Co-authored-by: Wolfgang Amann <8766375+wollefitz@users.noreply.github.com> Co-authored-by: Nico Rehwaldt <nico.rehwaldt@camunda.com> Co-authored-by: Deepthi Devaki Akkoorath <deepthidevaki@users.noreply.github.com> Co-authored-by: ultraschuppi <tim.schuppener@camunda.com> Co-authored-by: johanwelgemoed <112612181+johanwelgemoed@users.noreply.github.com> Co-authored-by: Nico Korthout <korthout@users.noreply.github.com> Co-authored-by: Josh Windels <joshua.windels@camunda.com> Co-authored-by: Valentin Serra <valentin.serra@camunda.com> Co-authored-by: Lars Lange <9141483+Langleu@users.noreply.github.com> Co-authored-by: Hamza Masood <47217263+HamzaMasood1@users.noreply.github.com> Co-authored-by: Rodrigo Lopes <132340590+rodrigo-lourenco-lopes@users.noreply.github.com>
related to OPT-7387
Description
When should this change go live?
hold
label or convert to draft PR)?PR Checklist
/versioned_docs
directory, or they are not for an already released version./docs
directory (aka/next/
), or they are not for future versions.