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.

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

chore: Add doc title to AWS Construct Library #2722

Merged
merged 7 commits into from
Jun 4, 2019

Conversation

RomainMuller
Copy link
Contributor

@RomainMuller RomainMuller commented Jun 3, 2019

Add titles for the awsdocs target to the AWS Construct Library
packages that are bound to a CloudFormation scope, using the standard
capitalization, so the documentation site looks better.

(Dependent on aws/jsii#512)


Pull Request Checklist

  • Testing
    • Unit test added (prefer not to modify an existing test, otherwise, it's probably a breaking change)
    • CLI change?: coordinate update of integration tests with team
    • cdk-init template change?: coordinated update of integration tests with team
  • Docs
    • jsdocs: All public APIs documented
    • README: README and/or documentation topic updated
    • Design: For significant features, design document added to design folder
  • Title and Description
    • Change type: title prefixed with fix, feat and module name in parens, which will appear in changelog
    • Title: use lower-case and doesn't end with a period
    • Breaking?: last paragraph: "BREAKING CHANGE: <describe what changed + link for details>"
    • Issues: Indicate issues fixed via: "Fixes #xxx" or "Closes #xxx"
  • Sensitive Modules (requires 2 PR approvers)
    • IAM Policy Document (in @aws-cdk/aws-iam)
    • EC2 Security Groups and ACLs (in @aws-cdk/aws-ec2)
    • Grant APIs (only if not based on official documentation with a reference)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.

Add titles for the `awsdocs` target to the AWS Construct Library
packages that are bound to a CloudFormation scope, using the standard
capitalization, so the documentation site looks better.
@RomainMuller RomainMuller marked this pull request as ready for review June 4, 2019 09:51
@RomainMuller RomainMuller requested review from skinny85, SoManyHs and a team as code owners June 4, 2019 09:51
@RomainMuller RomainMuller merged commit ff0ef73 into master Jun 4, 2019
@RomainMuller RomainMuller deleted the rmuller/doc-improvement branch June 4, 2019 14:05
@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants