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

update textract documentation with doc handing feature #4820

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

update textract documentation with doc handing feature #4820

wants to merge 1 commit into from
+20 −2

Conversation

DenovVasil
Copy link
Contributor

@DenovVasil DenovVasil commented Jan 7, 2025 •
edited by mesellings
Loading

Description

update textract documentation with doc handing feature
issue

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/).

@DenovVasil DenovVasil self-assigned this Jan 7, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 7, 2025 •
edited
Loading

👋 🤖 🤔 Hello, @DenovVasil! 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/connectors/out-of-the-box-connectors/amazon-textract.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.

@DenovVasil DenovVasil mentioned this pull request Jan 7, 2025
Merged
Szik
Szik reviewed Jan 17, 2025
View reviewed changes
Copy link
Contributor

@Szik Szik left a comment

Choose a reason for hiding this comment

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

see comments. but the rest looks good

docs/components/connectors/out-of-the-box-connectors/amazon-textract.md Outdated
In this mode, you can select the document location using **Document location type** field.

- S3
- Uploaded document
Copy link
Contributor

Choose a reason for hiding this comment

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

"Upload document" > "Camunda Document"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

docs/components/connectors/out-of-the-box-connectors/amazon-textract.md Outdated

:::note
**Real-time** execution only supports single-page PDFs. For multi-page PDFs, consider using **Polling** or **Asynchronous** execution. For more information, refer to [real-time PDF processing](https://aws.amazon.com/about-aws/whats-new/2022/01/amazon-textract-pdf-processing-jpeg-encoded-images/).
**Real-time** execution with **Uploaded document** location supports only PNG or JPEG formats.
Copy link
Contributor

Choose a reason for hiding this comment

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

"Upload document" > "Camunda Document"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

docs/components/connectors/out-of-the-box-connectors/amazon-textract.md Outdated
@@ -111,6 +120,15 @@ At least one feature type must be selected, and choosing multiple options can pr

Specify the **Document Version** if you need to process a specific version of the document. If unspecified, the latest version of the document is processed. Document versioning is useful for tracking changes over time or processing a specific document iteration.

#### Document

Mandatory only for **Real-time** execution with **Uploaded document** location type.
Copy link
Contributor

Choose a reason for hiding this comment

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

"Upload document" > "Camunda Document"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@DenovVasil DenovVasil force-pushed the 985-update-textract-doc branch from 8bca306 to f960db9 Compare January 21, 2025 20:25
@DenovVasil DenovVasil marked this pull request as ready for review January 21, 2025 20:26
@DenovVasil DenovVasil requested a review from mesellings January 21, 2025 20:28
@mesellings mesellings added deploy Stand up a temporary docs site with this PR component:docs Documentation improvements, including new or updated content component:connectors Issues related to the connectors project. labels Jan 22, 2025
@github-actions github-actions bot temporarily deployed to camunda-docs January 22, 2025 09:16 Destroyed
@DenovVasil DenovVasil force-pushed the 985-update-textract-doc branch from 51013a9 to 5e3ecc7 Compare February 6, 2025 10:31
@github-actions github-actions bot temporarily deployed to camunda-docs February 6, 2025 10:44 Destroyed
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 6, 2025

The preview environment relating to the commit 7211f8f has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-4820/index.html

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

@Szik Szik Szik left review comments

@mesellings mesellings Awaiting requested review from mesellings

At least 1 approving review is required to merge this pull request.

Assignees

@DenovVasil DenovVasil

Labels
component:connectors Issues related to the connectors project. component:docs Documentation improvements, including new or updated content deploy Stand up a temporary docs site with this PR
Projects
Developer Experience
Status: 🔖 Ready
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@DenovVasil @Szik @mesellings