Add Livesync for S3 docs #4047
Add Livesync for S3 docs #4047
Conversation
|
Allow 10 minutes from last push for the staging site to build. If the link doesn't work, try using incognito mode instead. For internal reviewers, check web-documentation repo actions for staging build status. Link to build for this PR: http://docs-dev.timescale.com/docs-vineeth-add-ls-s3-docs |
| - Access credentials for the S3 bucket. | ||
| - The user needs the following permissions: `s3:GetObject`, `s3:ListBucket`. | ||
| - The following credentials are supported: | ||
| - [IAM Role][credentials-iam]. |
There was a problem hiding this comment.
This must link to specific instructions. Users need to know which role they need to authorize.
This is already in our UI, Maybe we should have a dedicated page in the documentation as well?
There was a problem hiding this comment.
I think having the link to these instructions in the UI and a link to the docs is enough. We only rewrite things for other products when the docs are terrible.
There was a problem hiding this comment.
This is not about rewriting docs, There is a process specific for our setup that it is not in AWS docs.
I'm talking about this instructions in the UI
user needs to know
- The role we use is
"arn:aws:iam::142548018081:role/timescale-s3-connections" - We need permissions to
"s3:GetObject","s3:ListBucket" - We will send ExternalID with
ProjectID/ServiceID
This is not available in AWS docs because it is specific for our setup
atovpeko
left a comment
atovpeko
left a comment
There was a problem hiding this comment.
Should we also mention livesync on https://docs-dev.timescale.com/docs-vineeth-add-ls-s3-docs/migrate/vineeth-add-ls-s3-docs/?
Co-authored-by: Anastasiia Tovpeko <114177030+atovpeko@users.noreply.github.com> Signed-off-by: Iain Cox <iain@timescale.com>
Co-authored-by: Anastasiia Tovpeko <114177030+atovpeko@users.noreply.github.com> Signed-off-by: Iain Cox <iain@timescale.com>
* Add Livesync for S3 docs Co-authored-by: Iain <iain@timescale.com> Co-authored-by: Anastasiia Tovpeko <114177030+atovpeko@users.noreply.github.com>
Description
Livesync for S3 docs
Links
Fixes #[insert issue link, if any]
Writing help
For information about style and word usage, see the Contribution guide
Review checklists
Reviewers: use this section to ensure you have checked everything before approving this PR:
Subject matter expert (SME) review checklist
Documentation team review checklist
and have they been implemented?