aws-amplify / aws-amplify/amplify-cli

README and CLI help do not address `override` commands

Open
#11,634 1 comment 0 reactions 2 assignees Claimed by @goldbez View on GitHub
documentation feature-request p3 platform
Dominant language
TypeScript
Stars
2.9k
Forks
825
Avg merge
11d 23h
Merged PRs (30d)
2

Description

### Is this feature request related to a new or existing Amplify category?

New category

### Is this related to another service?

_No response_

### Describe the feature you'd like to request

README and CLI help address the `amplify override` command space.

### Describe the solution you'd like

The README should include the `override` command space in its documentation. The CLI should provide help that includes coverage of the `override` command space.

### Describe alternatives you've considered

Override commands are exclusively documented in the published website, e.g. https://docs.amplify.aws/cli/auth/override/ , and there is no consolidated page that covers all override commands. The CLI supports specific override commands. Therefore, the CLI help and README should each cover the command space.

### Additional context

Amplify published docs cover the `amplify override` commands distributed across the supported resources such as `project` and `storage`. The README in this repo and the `amplify help` CLI do not even indicate these overrides exist. The CLI returns a warning `The Amplify CLI can NOT find command: override` when prompted with `amplify override`.

### Is this something that you'd be interested in working on?

- [ ] 👋 I may be able to implement this feature request

### Would this feature include a breaking change?

- [ ] ⚠️ This feature might incur a breaking change

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.