awslabs / awslabs/aws-sdk-rust

Credentials caching docs are not discoverable

Open
#850 0 comments 1 reaction 0 assignees View on GitHub
documentation p3
Dominant language
Rust
Stars
3.3k
Forks
290
Avg merge
1d 12h
Merged PRs (30d)
3

Description

### Describe the issue

Customers looking at the [`SdkConfig`](https://docs.rs/aws-config/latest/aws_config/struct.SdkConfig.html#method.credentials_cache) docs, or other root configuration pieces of the aws-config crate, have to click through several layers of types in order to arrive at the [`LazyBuilder`](https://docs.rs/aws-credential-types/0.55.3/aws_credential_types/cache/struct.LazyBuilder.html) docs in order to see what is configurable on credentials caching.

This discovery pathway needs to be improved (and should also be improved on the generated service config).

### Links

See above.

Contributor guide

Open the contributing guide

Research direction

Start with the linked SdkConfig and LazyBuilder documentation, then inspect the aws-config root configuration docs and the generated service config documentation. The work is done when credentials-caching configuration is discoverable from those entry points without requiring several layers of navigation.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.