aws / aws/aws-cli

"See also: AWS API Documentation" in help pages should show URL

Open
#7,837 1 comment 0 reactions 0 assignees View on GitHub
documentation feature-request p2
Dominant language
Python
Stars
17.3k
Forks
4.6k
Avg merge
1d 2h
Merged PRs (30d)
13

Description

### Describe the feature

If I look at the docs for a call, e.g.

```
aws transfer test-identity-provider help
```

The docs say

> See also: AWS API Documentation

In other docs, such as boto3, "See also: AWS API Documentation" is a hyperlink to the docs
e.g. https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/test_identity_provider.html
links to
https://docs.aws.amazon.com/transfer/latest/userguide/API_TestIdentityProvider.html

But for the cli, since this is just stdout in a terminal, that's not a link I can click on.

I would like the `aws x help` description to print the URL itself.

> See also: AWS API Documentation at https://docs.aws.amazon.com/transfer/latest/userguide/API_TestIdentityProvider.html

### Use Case

I want to look at the original documentation, to debug something different between cli and console when talking to AWS support

### Proposed Solution

_No response_

### Other Information

_No response_

### Acknowledgements

- [ ] I may be able to implement this feature request
- [ ] This feature might incur a breaking change

### CLI version used

2.8.9

### Environment details (OS name and version, etc.)

Mac

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.