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

docs(vpc): update VPC documentation in README and API #3810

Merged
merged 4 commits into from
Aug 29, 2019

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented Aug 27, 2019

Try to address common gotchas with the VPC component in the
package documentation.

Addresses part of #3704.


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

Try to address common gotchas with the VPC component in the
package documentation.

Addresses part of #3704.
@rix0rrr rix0rrr self-assigned this Aug 27, 2019
packages/@aws-cdk/aws-ec2/README.md Outdated Show resolved Hide resolved
packages/@aws-cdk/aws-ec2/README.md Outdated Show resolved Hide resolved

```ts
import ec2 = require('@aws-cdk/aws-ec2');
How many Availability Zones are available depends on the *region* and
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Minor rephrase on 1st line: "The number of availability zones that are available depend on ..."

  2. I was aware that AZs are dependent on the region but didn't know they were dependent on the account. Are they?

  3. Link to this page would be useful - https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#using-regions-availability-zones-describe

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Yes, although this mostly only happens when new AZs are introduced and there is a whitelisting period.

account, and import the subnet configuration. Looking up can be done by VPC
ID, but more flexibly by searching for a specific tag on the VPC.

The import does assume that the VPC will be *symmetric*, i.e. that there are
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What happens if this assumption is not true? Specify that.

eladb
eladb previously approved these changes Aug 27, 2019
@rix0rrr
Copy link
Contributor Author

rix0rrr commented Aug 28, 2019

Fixes #3810.

@mergify
Copy link
Contributor

mergify bot commented Aug 29, 2019

Pull Request Checklist

  • Testing
  • Unit test added (prefer to add a new test rather than modify existing tests)
  • CLI change? Re-run/add CLI integration tests
  • Documentation
  • Inline docs: make sure all public APIs are documented (copy & paste from official AWS docs)
  • README: update module README
  • Design: for significant features, follow the design process
  • Title uses the format type(scope): text
  • Type: fix, feat, refactor go into CHANGELOG, chore is hidden
  • Scope: name of the module without the aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
  • Style: use all lower-case, do not end with a period
  • Description
  • Rationale: describe rationale of change and approach taken
  • Issues: Indicate issues fixed via: fixes #xxx or closes #xxx
  • Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
  • Sensitive Modules (requires 2 PR approvers)
  • IAM document library (in @aws-cdk/aws-iam)
  • EC2 security groups and ACLs (in @aws-cdk/aws-ec2)
  • Grant APIs (if not based on official documentation with a reference)

@mergify mergify bot dismissed nija-at’s stale review August 29, 2019 10:01

Pull request has been modified.

@mergify
Copy link
Contributor

mergify bot commented Aug 29, 2019

Thank you for contributing! Your pull request is now being automatically merged.

@mergify
Copy link
Contributor

mergify bot commented Aug 29, 2019

Codebuild (Continuous Integration) build failed for current commits. Please check log and resolve before PR is merged.

@rix0rrr rix0rrr merged commit d71175f into master Aug 29, 2019
@rix0rrr rix0rrr deleted the huijbers/vpc-docs branch August 29, 2019 11:45
@rix0rrr rix0rrr added review/small effort/small Small work item – less than a day of effort and removed review/small labels Sep 16, 2019
@mergify
Copy link
Contributor

mergify bot commented Sep 16, 2019

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist
:

  • PR title type(scope): text
    • type: fix, feat, refactor go into CHANGELOG, chore is hidden
    • scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
    • text: use all lower-case, do not end with a period, do not include issue refs
  • PR Description
    • Rationale: describe rationale of change and approach taken
    • Issues: indicate issues fixed via: fixes #xxx or closes #xxx
    • Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
  • Testing
    • Unit test added. Prefer to add a new test rather than modify existing tests
    • CLI or init templates change? Re-run/add CLI integration tests
  • Documentation
    • README: update module README to describe new features
    • API docs: public APIs must be documented. Copy from official AWS docs when possible
    • Design: for significant features, follow design process

@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. effort/small Small work item – less than a day of effort
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants