connectors and optimize sm docs review #3119
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
christinaausley
added
component:optimize
RomanJRW
reviewed
Dec 21, 2023
akeller
approved these changes
Jan 3, 2024
maryarm
pushed a commit
that referenced
this pull request
Jan 5, 2024
* connectors and sm docs review * resolve comments
christinaausley
added a commit
that referenced
this pull request
Jan 5, 2024
#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 <[email protected]> * 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 <[email protected]> * feat(connectors): added note on OData support (#3046) * feat(connectors): added note on OData support * style(formatting): technical review --------- Co-authored-by: Christina Ausley <[email protected]> * 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 <[email protected]> * 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 <[email protected]> * 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 <[email protected]> * 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 <[email protected]> * Update optimize_sidebars.js Co-authored-by: Christian Konrad <[email protected]> * Update docs/self-managed/tasklist-deployment/tasklist-authentication.md Co-authored-by: Christian Konrad <[email protected]> * Update docs/self-managed/concepts/access-control/user-restrictions.md Co-authored-by: Christian Konrad <[email protected]> * Update docs/self-managed/concepts/access-control/user-restrictions.md Co-authored-by: Christian Konrad <[email protected]> * Update docs/self-managed/identity/deployment/configuration-variables.md Co-authored-by: Christian Konrad <[email protected]> * Update docs/self-managed/concepts/access-control/user-restrictions.md Co-authored-by: Christian Konrad <[email protected]> * Update docs/self-managed/concepts/access-control/user-restrictions.md Co-authored-by: Christian Konrad <[email protected]> * Update docs/self-managed/concepts/access-control/user-restrictions.md Co-authored-by: Christian Konrad <[email protected]> * Update docs/self-managed/concepts/access-control/user-restrictions.md Co-authored-by: Christian Konrad <[email protected]> * Update docs/self-managed/concepts/access-control/user-restrictions.md Co-authored-by: Christian Konrad <[email protected]> * Update docs/self-managed/concepts/access-control/user-restrictions.md Co-authored-by: Christian Konrad <[email protected]> * Update docs/self-managed/concepts/access-control/user-restrictions.md Co-authored-by: Christian Konrad <[email protected]> * Update docs/self-managed/concepts/access-control/user-restrictions.md Co-authored-by: Christian Konrad <[email protected]> * Update docs/self-managed/concepts/access-control/user-restrictions.md Co-authored-by: Christian Konrad <[email protected]> * Update docs/self-managed/tasklist-deployment/tasklist-authentication.md Co-authored-by: Christian Konrad <[email protected]> * Add code review changes * Update user-task-access-restrictions.md --------- Co-authored-by: Christina Ausley <[email protected]> Co-authored-by: Christian Konrad <[email protected]> Co-authored-by: christinaausley <[email protected]> Co-authored-by: Amara Graham <[email protected]> * 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 <[email protected]> Co-authored-by: Wolfgang Amann <[email protected]> * 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 <[email protected]> * Update versioned_docs/version-8.3/guides/migrating-from-camunda-7/conceptual-differences.md Co-authored-by: Nikola Koevski <[email protected]> --------- Co-authored-by: Christina Ausley <[email protected]> Co-authored-by: christinaausley <[email protected]> Co-authored-by: Nikola Koevski <[email protected]> * 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 <[email protected]> * 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 <[email protected]> Co-authored-by: Christina Ausley <[email protected]> * 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 <[email protected]> * update optimize description * run prettier * update css for line clamp woohoo --------- Co-authored-by: Steven Hicks <[email protected]> * 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 <[email protected]> * 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 <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Christina Ausley <[email protected]> * 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 <[email protected]> * 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 <[email protected]> * 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 <[email protected]> * docs(connectors): explained several fields (#3102) * docs(connectors): explained several fields * applied PR comments * style(formatting): technical review --------- Co-authored-by: Christina Ausley <[email protected]> * 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 <[email protected]> * 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 <[email protected]> * 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 <[email protected]> * 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 <[email protected]> Co-authored-by: Josh Windels <[email protected]> * 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 <[email protected]> * 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 <[email protected]> Co-authored-by: Ahmed AbouZaid <[email protected]> * 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 <[email protected]> Co-authored-by: christinaausley <[email protected]> * 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 <[email protected]> * 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 <[email protected]> Co-authored-by: christinaausley <[email protected]> * 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 <[email protected]> * 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 <[email protected]> * docs(identity): apply review comments --------- Co-authored-by: maryam.nematigavzan <[email protected]> Co-authored-by: christinaausley <[email protected]> Co-authored-by: Hüsna Uygur <[email protected]> Co-authored-by: Igor Petrov <[email protected]> Co-authored-by: Christina Ausley <[email protected]> Co-authored-by: Steven Hicks <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Pavel Kotelevsky <[email protected]> Co-authored-by: Philipp Fromme <[email protected]> Co-authored-by: Adam Boczek <[email protected]> Co-authored-by: Amara Graham <[email protected]> Co-authored-by: Tim Stawowski <[email protected]> Co-authored-by: Jonathan Lukas <[email protected]> Co-authored-by: Amara <[email protected]> Co-authored-by: MaxTru <[email protected]> Co-authored-by: Nathanyel Sandi <[email protected]> Co-authored-by: Christian Konrad <[email protected]> Co-authored-by: Valentino Pellegrino <[email protected]> Co-authored-by: Wolfgang Amann <[email protected]> Co-authored-by: berkaycanbc <[email protected]> Co-authored-by: Patrick Dehn <[email protected]> Co-authored-by: Nikola Koevski <[email protected]> Co-authored-by: Jesse Simpson <[email protected]> Co-authored-by: Ahmed AbouZaid <[email protected]> Co-authored-by: Oleksii Ivanov <[email protected]> Co-authored-by: Michał Konopski <[email protected]> Co-authored-by: Steven Hicks <[email protected]> Co-authored-by: Simon <[email protected]> Co-authored-by: Houssain Barouni <[email protected]> Co-authored-by: Ana <[email protected]> Co-authored-by: Abbas Adel Ibraim <[email protected]> Co-authored-by: Wolfgang Amann <[email protected]> Co-authored-by: Nico Rehwaldt <[email protected]> Co-authored-by: Deepthi Devaki Akkoorath <[email protected]> Co-authored-by: ultraschuppi <[email protected]> Co-authored-by: johanwelgemoed <[email protected]> Co-authored-by: Nico Korthout <[email protected]> Co-authored-by: Josh Windels <[email protected]> Co-authored-by: Valentin Serra <[email protected]> Co-authored-by: Lars Lange <[email protected]> Co-authored-by: Hamza Masood <[email protected]> Co-authored-by: Rodrigo Lopes <[email protected]>
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.
Description
Relates to https://github.com/camunda/developer-experience/issues/63.
When should this change go live?
holdlabel or convert to draft PR)?PR Checklist
/versioned_docsdirectory, or they are not for an already released version./docsdirectory (aka/next/), or they are not for future versions.