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

update document handling content #4907

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

christinaausley
Copy link
Contributor

Description

Revamping the document handling documentation for 0.1 based on feedback.

Closes camunda/camunda#27452 and should provide a more unified developer journey through the entire product, not separate components.

When should this change go live?

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

PR Checklist

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

@christinaausley christinaausley added the target:8.7 Issues included in the 8.7 release label Jan 29, 2025
@christinaausley christinaausley self-assigned this Jan 29, 2025
@christinaausley christinaausley changed the title update-document-handling-content update document handling content Jan 29, 2025
Copy link
Contributor

github-actions bot commented Jan 29, 2025

👋 🤖 🤔 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-handling-tasklist.png
  • docs/components/concepts/document-handling.md
  • docs/components/connectors/img/document-handling/email-connector.png
  • docs/components/connectors/out-of-the-box-connectors/email.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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note to self to resize images as they are a bit large.

For the following outbound Connectors, you may include a **Request body** under **Payload** in the properties panel to send with your request:

- [REST](/components/connectors/protocol/rest.md) - Supports storing the response as a document.
- [Email](/components/connectors/out-of-the-box-connectors/email.md#response-structure-1) - Supports sending Camunda documents as attachments, or storing incoming attachments as Camunda documents.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

or storing incoming attachments as Camunda documents

How exactly does this work and is it already supported?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
target:8.7 Issues included in the 8.7 release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc] Review documentation for document handling
1 participant