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

fix(cli): make cdk docs open the new API reference #2633

Merged
merged 1 commit into from May 24, 2019
Merged

fix(cli): make cdk docs open the new API reference #2633

merged 1 commit into from May 24, 2019

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented May 24, 2019

Point cdk docs to the new URL for docs.

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.

@rix0rrr
fix(cli): make cdk docs open the new API reference
8ea35db 
Point `cdk docs` to the new URL for docs.
@rix0rrr rix0rrr requested a review from a team as a code owner May 24, 2019 14:13
Doug-AWS
Doug-AWS approved these changes May 24, 2019
View reviewed changes
Copy link
Contributor

@Doug-AWS Doug-AWS left a comment

Choose a reason for hiding this comment

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

Looks good, thanks.

eladb
eladb approved these changes May 24, 2019
View reviewed changes
packages/aws-cdk/lib/commands/docs.ts
@@ -26,8 +26,7 @@ export function handler(args: yargs.Arguments) {
}

export async function realHandler(options: CommandOptions): Promise<number> {
const docVersion = require('../../package.json').version;
const url = `https://awslabs.github.io/aws-cdk/versions/${docVersion}/`;
const url = `https://docs.aws.amazon.com/cdk/api/latest/`;
Copy link
Contributor

Choose a reason for hiding this comment

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

Why not the correct version? (or do we still don't have that, in which case open an issue so we don't forget).

@rix0rrr rix0rrr merged commit 6450758 into master May 24, 2019
@rix0rrr rix0rrr deleted the huijbers/update-docs-url branch May 24, 2019 15:29
This was referenced Aug 22, 2019
Open
Open
Open
Open
Open
@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 27, 2019
This was referenced Dec 12, 2019
Closed
Closed
Closed
Merged
Closed
Closed
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
This was referenced Jan 20, 2020
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eladb eladb eladb approved these changes

@Doug-AWS Doug-AWS Doug-AWS approved these changes

Assignees
No one assigned
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@rix0rrr @eladb @Doug-AWS @NGL321