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 AWS documentation with different authorisation methods #2234

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Update AWS documentation with different authorisation methods #2234

wants to merge 7 commits into from
+241 −54

Conversation

maxim-morozov
Copy link
Collaborator

Reference Issues/PRs

What does this implement or fix?

Updates the AWS documentation with step by step guidance how to enable different authorisation methods for ArcticDB

Any other comments?

Checklist

Checklist for code changes...
  • Have you updated the relevant docstrings, documentation and copyright notice?
  • Is this contribution tested against all ArcticDB's features?
  • Do all exceptions introduced raise appropriate error messages?
  • Are API changes highlighted in the PR description?
  • Is the PR labelled as enhancement or bug so it appears in autogenerated release notes?

G-D-Petrov
G-D-Petrov reviewed Mar 12, 2025
View reviewed changes
docs/mkdocs/docs/aws.md

#### Solution:
- Verify your network connection.
- Ensure that the S3 endpoint is reachable from your environment.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd add some steps at the end of this section on how to debug these types of problems in general, like:

  1. how to enable the AWS logs locally
  2. where to find them
  3. what are some basic things to look for in there

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks for suggestion @G-D-Petrov. I have added a statement referring the user to the page explaining enablement of additional logging.

@maxim-morozov maxim-morozov added documentation Improvements or additions to documentation patch Small change, should increase patch version labels Mar 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@G-D-Petrov G-D-Petrov G-D-Petrov left review comments

@jamesmunro jamesmunro jamesmunro approved these changes

@phoebusm phoebusm phoebusm approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation patch Small change, should increase patch version
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@maxim-morozov @jamesmunro @G-D-Petrov @phoebusm