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(aws-s3): add documentation for the new aws s3 connector #4746

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

mathias-vandaele
Copy link
Contributor

@mathias-vandaele mathias-vandaele commented Dec 11, 2024

Description

This is the documentation of AWS S3 connector which will be release on 8.7.0-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/).

@mathias-vandaele mathias-vandaele added the hold This issue is parked, do not merge. label Dec 11, 2024
@mathias-vandaele mathias-vandaele requested a review from a team December 11, 2024 08:26
Copy link
Contributor

github-actions bot commented Dec 11, 2024

👋 🤖 🤔 Hello, @mathias-vandaele! 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-s3.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.

Comment on lines +253 to +255
axiosRef.defaults.headers[
"Authorization"
] = `Bearer ${credentials.access_token}`;
Copy link
Contributor

Choose a reason for hiding this comment

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

[prettier] reported by reviewdog 🐶

Suggested change
axiosRef.defaults.headers[
"Authorization"
] = `Bearer ${credentials.access_token}`;
axiosRef.defaults.headers["Authorization"] =
`Bearer ${credentials.access_token}`;

Comment on lines +253 to +255
axiosRef.defaults.headers[
"Authorization"
] = `Bearer ${credentials.access_token}`;
Copy link
Contributor

Choose a reason for hiding this comment

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

[prettier] reported by reviewdog 🐶

Suggested change
axiosRef.defaults.headers[
"Authorization"
] = `Bearer ${credentials.access_token}`;
axiosRef.defaults.headers["Authorization"] =
`Bearer ${credentials.access_token}`;

Copy link
Contributor

@mesellings mesellings Dec 12, 2024

Choose a reason for hiding this comment

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

@mathias-vandaele Is this Prettier suggestion okay to commit - looks ok, but want to check 👍

Comment on lines +253 to +255
axiosRef.defaults.headers[
"Authorization"
] = `Bearer ${credentials.access_token}`;
Copy link
Contributor

Choose a reason for hiding this comment

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

[prettier] reported by reviewdog 🐶

Suggested change
axiosRef.defaults.headers[
"Authorization"
] = `Bearer ${credentials.access_token}`;
axiosRef.defaults.headers["Authorization"] =
`Bearer ${credentials.access_token}`;

Comment on lines +253 to +255
axiosRef.defaults.headers[
"Authorization"
] = `Bearer ${credentials.access_token}`;
Copy link
Contributor

Choose a reason for hiding this comment

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

[prettier] reported by reviewdog 🐶

Suggested change
axiosRef.defaults.headers[
"Authorization"
] = `Bearer ${credentials.access_token}`;
axiosRef.defaults.headers["Authorization"] =
`Bearer ${credentials.access_token}`;

Comment on lines +253 to +255
axiosRef.defaults.headers[
"Authorization"
] = `Bearer ${credentials.access_token}`;
Copy link
Contributor

Choose a reason for hiding this comment

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

[prettier] reported by reviewdog 🐶

Suggested change
axiosRef.defaults.headers[
"Authorization"
] = `Bearer ${credentials.access_token}`;
axiosRef.defaults.headers["Authorization"] =
`Bearer ${credentials.access_token}`;

@mesellings
Copy link
Contributor

@mathias-vandaele when does this need to be published please?

@mesellings mesellings requested review from mesellings and removed request for a team December 12, 2024 08:34
@mesellings mesellings added kind/feature Issues related with features to be documented component:docs Documentation improvements, including new or updated content component:connectors Issues related to the connectors project. deploy Stand up a temporary docs site with this PR 8.7.0-alpha3 January 2024 alpha release labels Dec 12, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs December 12, 2024 08:47 Destroyed
mesellings
mesellings previously approved these changes Dec 12, 2024
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.

@mathias-vandaele Approved 👍 (I committed my changes directly - just the random prettier code suggestions you can decide to include or not)

@github-actions github-actions bot temporarily deployed to camunda-docs December 12, 2024 10:05 Destroyed
@mathias-vandaele
Copy link
Contributor Author

@mathias-vandaele Approved 👍 (I committed my changes directly - just the random prettier code suggestions you can decide to include or not)

@mesellings made a few changes, let me know if everything is good, should be merged when next release is coming 8.7.0-alpha3 on january 7

@github-actions github-actions bot temporarily deployed to camunda-docs December 20, 2024 10:05 Destroyed
Copy link
Contributor

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

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.

Lgtm - one non-blocking suggestion 👍

| Parameter | Description |
| :----------- | :----------------------------------------------------------------------------------------------------------------------------------------------- |
| `AWS bucket` | The targeted AWS S3 bucket where the document should be uploaded. |
| `AWS key` | (Optional) The key of the document that uniquely identifies the object in an Amazon S3 bucket. Will fallback to the document filename if not set |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
| `AWS key` | (Optional) The key of the document that uniquely identifies the object in an Amazon S3 bucket. Will fallback to the document filename if not set |
| `AWS key` | (Optional) The key of the document that uniquely identifies the object in an Amazon S3 bucket. Will fallback to the document filename if not set. |

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.7.0-alpha3 January 2024 alpha release 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 hold This issue is parked, do not merge. kind/feature Issues related with features to be documented
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

2 participants