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

Centralize SDK README generation #770

Open
jdisanti opened this issue Oct 14, 2021 · 0 comments
Open

Centralize SDK README generation #770

jdisanti opened this issue Oct 14, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation ops Improves our operations and release process

Comments

@jdisanti
Copy link
Collaborator

Currently, the SDK has two READMEs:

  1. The top-level readme in the aws-sdk-rust repository that displays on GitHub
  2. Individual, generated, service READMEs that are in each service crate. These are generated in AwsReadmeDecorator and have a lot of duplicated content from the top-level README.

We need to find a way to centralize the information in these READMEs so that we only have to update them in one place.
@jdisanti jdisanti added the ops Improves our operations and release process label Oct 14, 2021
@jdisanti jdisanti mentioned this issue Oct 14, 2021
Merged
2 tasks
@rcoh rcoh added the documentation Improvements or additions to documentation label Dec 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation ops Improves our operations and release process
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jdisanti @rcoh