Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

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

Jump to bottom

draft framework for document handling #4774

Merged
merged 18 commits into from
Jan 14, 2025
Merged

draft framework for document handling #4774

merged 18 commits into from
Jan 14, 2025

Conversation

christinaausley
Copy link
Contributor

@christinaausley christinaausley commented Dec 13, 2024 •
edited
Loading

Description

Relates to https://github.com/camunda/product-hub/issues/2555.

Document handling content for alpha-3.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@christinaausley christinaausley added the 8.7.0-alpha3 January 2024 alpha release label Dec 13, 2024
@christinaausley christinaausley self-assigned this Dec 13, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 13, 2024 •
edited
Loading

👋 🤖 🤔 Hello, @christinaausley! 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.6/.

  • docs/components/concepts/assets/document-preview-settings.png
  • docs/components/concepts/assets/document-preview.png
  • docs/components/concepts/assets/inbound-webhook-document.png
  • docs/components/concepts/assets/rest-outbound-document.png
  • docs/components/concepts/document-handling.md
  • docs/components/connectors/out-of-the-box-connectors/amazon-bedrock.md
  • docs/components/connectors/out-of-the-box-connectors/amazon-s3.md
  • docs/components/connectors/out-of-the-box-connectors/amazon-textract.md
  • docs/components/connectors/out-of-the-box-connectors/box.md
  • docs/components/connectors/out-of-the-box-connectors/email.md
  • docs/components/connectors/protocol/http-webhook.md
  • docs/components/connectors/protocol/rest.md
  • docs/components/modeler/forms/form-element-library/forms-element-library-document-preview.md
  • docs/components/modeler/forms/form-element-library/forms-element-library-filepicker.md
  • docs/components/tasklist/userguide/using-tasklist.md

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.

@christinaausley christinaausley added the deploy Stand up a temporary docs site with this PR label Dec 18, 2024
christinaausley
christinaausley commented Dec 18, 2024
View reviewed changes
docs/components/concepts/document-handling.md Outdated

![example payload inbound webhook connector](./assets/inbound-webhook-document.png)

### Outbound (REST and IDP-related) Connectors
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@crobbins215 Can you clarify for me which Connectors this will apply to so I can apply the appropriate content to those docs?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@christinaausley The wording "IDP-related" is too generic and might not be clear to readers.
I'm aware that the following connectors can support files: inbound Webhook connector, outbound REST and Email connectors.
@chillleader Any other connectors that we should mention here?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's the latest list of connectors supporting document capabilities:

  • Webhook
  • REST
  • Email
  • AWS Textract
  • AWS Bedrock
  • AWS S3
  • BOX Connector
  • IDP (extraction) connector - but it's for internal use as far as I know

Another one upcoming - Google Drive.

@christinaausley christinaausley marked this pull request as ready for review January 9, 2025 13:56
@github-actions github-actions bot temporarily deployed to camunda-docs January 9, 2025 15:38 Destroyed
conceptualshark
conceptualshark previously approved these changes Jan 9, 2025
View reviewed changes
Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two small, non-blocking comments so far, but otherwise this looks good to me!

docs/components/concepts/document-handling.md Outdated Show resolved Hide resolved
docs/components/concepts/document-handling.md Outdated Show resolved Hide resolved
@akeller
Copy link
Member

akeller commented Jan 13, 2025

@christinaausley what's the status of this PR? Are you planning for it to go out tomorrow with alpha3?

@christinaausley
Copy link
Contributor Author

@akeller I have connected with @volodymyr-melnykc via Slack for one final approval before merging 😄

@github-actions github-actions bot temporarily deployed to camunda-docs January 14, 2025 09:58 Destroyed
volodymyr-melnykc
volodymyr-melnykc reviewed Jan 14, 2025
View reviewed changes
docs/components/concepts/document-handling.md Outdated Show resolved Hide resolved
docs/components/concepts/document-handling.md Outdated Show resolved Hide resolved
docs/components/concepts/document-handling.md Outdated

![example payload inbound webhook connector](./assets/inbound-webhook-document.png)

### Outbound (REST and IDP-related) Connectors
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@christinaausley The wording "IDP-related" is too generic and might not be clear to readers.
I'm aware that the following connectors can support files: inbound Webhook connector, outbound REST and Email connectors.
@chillleader Any other connectors that we should mention here?

docs/components/concepts/assets/document-preview.png Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to camunda-docs January 14, 2025 14:12 Destroyed
@christinaausley
Copy link
Contributor Author

@chillleader @volodymyr-melnykc This is ready for final review 👍

@github-actions github-actions bot temporarily deployed to camunda-docs January 14, 2025 15:03 Destroyed
chillleader
chillleader reviewed Jan 14, 2025
View reviewed changes
Copy link
Member

@chillleader chillleader left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thank you! The only comment from my side is that we should be more specific in notes that describe document-related functionality of each connector.

docs/components/connectors/out-of-the-box-connectors/amazon-bedrock.md Outdated Show resolved Hide resolved
docs/components/connectors/out-of-the-box-connectors/amazon-s3.md Outdated Show resolved Hide resolved
docs/components/connectors/out-of-the-box-connectors/amazon-textract.md Outdated Show resolved Hide resolved
docs/components/connectors/out-of-the-box-connectors/box.md Outdated Show resolved Hide resolved
docs/components/connectors/out-of-the-box-connectors/email.md Outdated Show resolved Hide resolved
@christinaausley
Copy link
Contributor Author

christinaausley commented Jan 14, 2025 •
edited
Loading

Thank you @chillleader -- this was going to be my lingering comment for you. I have tidied up these Connectors notes 👍

@github-actions github-actions bot temporarily deployed to camunda-docs January 14, 2025 15:48 Destroyed
@akeller
Copy link
Member

akeller commented Jan 14, 2025

@christinaausley are you still planning for this to go live today? How can we support you?

@christinaausley
Copy link
Contributor Author

@akeller I feel this is in a good enough state to merge. If @chillleader has any lingering comments I can adjust in another PR -- just need an approval to merge here, and then I can do another docs release.

@christinaausley christinaausley enabled auto-merge (squash) January 14, 2025 20:27
@christinaausley christinaausley requested a review from a team January 14, 2025 20:31
conceptualshark
conceptualshark approved these changes Jan 14, 2025
View reviewed changes
Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀 This looks great to me!

@christinaausley christinaausley merged commit 7b41a40 into main Jan 14, 2025
10 checks passed
@christinaausley christinaausley deleted the doc-handling-capability branch January 14, 2025 20:40
@github-actions GitHub Actions
Copy link
Contributor

🧹 Preview environment for this PR has been torn down.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@conceptualshark conceptualshark conceptualshark approved these changes

@volodymyr-melnykc volodymyr-melnykc volodymyr-melnykc left review comments

@marcosgvieira marcosgvieira Awaiting requested review from marcosgvieira

@chillleader chillleader Awaiting requested review from chillleader

Assignees

@christinaausley christinaausley

Labels
8.7.0-alpha3 January 2024 alpha release deploy Stand up a temporary docs site with this PR
Projects
Developer Experience
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@christinaausley @akeller @chillleader @conceptualshark @volodymyr-melnykc