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.

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: add textract doc #4239

Merged
merged 3 commits into from
Oct 7, 2024
Merged

docs: add textract doc #4239

merged 3 commits into from
Oct 7, 2024

Conversation

DenovVasil
Copy link
Contributor

@DenovVasil DenovVasil commented Sep 3, 2024

Description

Add Textract documentation

dev ticket
epic

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

Copy link
Contributor

github-actions bot commented Sep 3, 2024

👋 🤖 🤔 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.5/.

  • docs/components/connectors/out-of-the-box-connectors/amazon-textract.md
  • docs/components/connectors/out-of-the-box-connectors/available-connectors-overview.md
  • docs/components/react-components/connector-task.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.

@mesellings
Copy link
Contributor

@DenovVasil Do you need a technical writer review for this work?

@Oleksiivanov Oleksiivanov added the hold This issue is parked, do not merge. label Sep 3, 2024
@DenovVasil
Copy link
Contributor Author

@DenovVasil Do you need a technical writer review for this work?

yes but after the engineers review. I will ping you when I get approvals from the engineers

@DenovVasil DenovVasil force-pushed the 3162-add-textract-documentation branch 5 times, most recently from fdc86c5 to 46688f2 Compare September 6, 2024 13:52
To store the **Text** from the first block in a variable `lineText`, the **Confidence** in `textConfidence`, and the **BlockType** in `blockType`, use the following result **expression**:

```feel
= {lineText: blocks[2].text, textConfidence: blocks[2].confidence, blockType: blocks[2].blockType}
Copy link
Contributor

Choose a reason for hiding this comment

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

With provided example it should take first aray block :
= {lineText: blocks[2].text, textConfidence: blocks[2].confidence, blockType: blocks[2].blockType}

Suggested change
= {lineText: blocks[2].text, textConfidence: blocks[2].confidence, blockType: blocks[2].blockType}
= {lineText: blocks[0].text, textConfidence: blocks[0].confidence, blockType: blocks[0].blockType}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is a real example, and in my case index:2 contains all the necessary values

Oleksiivanov
Oleksiivanov previously approved these changes Sep 6, 2024
Copy link
Contributor

@Oleksiivanov Oleksiivanov left a comment

Choose a reason for hiding this comment

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

LGTM. Don't forget to add this documentation to the versioned_docs directory if needed, and add label to this PR with the release version. Move it to 'Ready for Review' and consider adding the Connector teams as reviewers, as well as @camunda/tech-writers as the technical reviewer

@DenovVasil DenovVasil force-pushed the 3162-add-textract-documentation branch from 46688f2 to 6727651 Compare September 6, 2024 15:30
@DenovVasil DenovVasil marked this pull request as ready for review September 6, 2024 15:36
@johnBgood johnBgood added the deploy Stand up a temporary docs site with this PR label Sep 6, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs September 6, 2024 16:16 Destroyed
johnBgood
johnBgood previously approved these changes Sep 9, 2024
@DenovVasil DenovVasil added target:8.6 Issues included in the 8.6 release and removed hold This issue is parked, do not merge. labels Sep 9, 2024
@DenovVasil
Copy link
Contributor Author

DenovVasil commented Sep 9, 2024

@DenovVasil Do you need a technical writer review for this work?

@mesellings Can you pleas make a technical writer review ?

@github-actions github-actions bot temporarily deployed to camunda-docs September 9, 2024 07:23 Destroyed
@mesellings mesellings self-requested a review September 9, 2024 13:06
@mesellings mesellings self-assigned this Sep 9, 2024
@mesellings
Copy link
Contributor

@DenovVasil I can review this for you 👍

Oleksiivanov
Oleksiivanov previously approved these changes Sep 11, 2024
@christinaausley
Copy link
Contributor

@DenovVasil I can review this for you 👍

Sorry @mesellings I didn't see this. Please of course feel free to have a look over this -- four eyes are better than two. I just made a handful of grammatical adjustments anyways.

@mesellings mesellings added the hold This issue is parked, do not merge. label Sep 16, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs September 16, 2024 15:47 Destroyed
@mesellings
Copy link
Contributor

@DenovVasil I will review this today - I'll probably make some commits directly to the branch as well 👍

Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

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

@DenovVasil Lgtm - I have made some edits as follows:

  • Restructuring and heading levels
  • Rewording for clarity, active voice etc.

Happy to approve - great work 👍

@github-actions github-actions bot temporarily deployed to camunda-docs September 17, 2024 14:04 Destroyed
@mesellings
Copy link
Contributor

@DenovVasil Is this ready to be merged for the 8.6 release next week?

@github-actions github-actions bot temporarily deployed to camunda-docs October 1, 2024 15:55 Destroyed
@DenovVasil DenovVasil force-pushed the 3162-add-textract-documentation branch from 5a1d3c4 to 5f39915 Compare October 7, 2024 12:55
@DenovVasil DenovVasil removed hold This issue is parked, do not merge. deploy Stand up a temporary docs site with this PR labels Oct 7, 2024
Copy link
Contributor

github-actions bot commented Oct 7, 2024

🧹 Preview environment for this PR has been torn down.

@DenovVasil DenovVasil merged commit 9219a97 into main Oct 7, 2024
9 of 11 checks passed
@DenovVasil DenovVasil deleted the 3162-add-textract-documentation branch October 7, 2024 13:20
christinaausley pushed a commit that referenced this pull request Oct 7, 2024
* docs: add textract doc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
target:8.6 Issues included in the 8.6 release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants