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 (docs): Readme.md files need vetting for 0.36.0 release #3079

Closed
1 of 5 tasks
Doug-AWS opened this issue Jun 26, 2019 · 2 comments
Closed
1 of 5 tasks

Chore (docs): Readme.md files need vetting for 0.36.0 release #3079

Doug-AWS opened this issue Jun 26, 2019 · 2 comments

Comments

@Doug-AWS
Copy link
Contributor

Note: for support questions, please first reference our documentation, then use Stackoverflow. This repository's issues are intended for feature requests and bug reports.

  • I'm submitting a ...

    • 🪲 bug report
    • 🚀 feature request
    • 📚 construct library gap
    • ☎️ security issue or vulnerability => Please see policy
    • ❓ support request => Please see note at the top of this template.
  • What is the current behavior?
    For example, the breaking changes state:

core: Context.getSsmParameter has been removed. Use ssm.StringParameter.valueFromLookup

However, the readme shows (first for a plain string; second for a secret string):

const stringValue = ssm.StringParameter.fromStringParameterAttributes
const secretValue = ssm.StringParameter.fromSecureStringParameterAttributes

I suspect we'll find other instances of similar out-of-date docs.

If the current behavior is a 🪲bug🪲: Please provide the steps to reproduce

  • What is the expected behavior (or behavior of feature suggested)?

  • What is the motivation / use case for changing the behavior or adding this feature?

  • Please tell us about your environment:

    • CDK CLI Version: xx.xx.xx
    • Module Version: xx.xx.xx
    • OS: [all | Windows 10 | OSX Mojave | Ubuntu | etc... ]
    • Language: [all | TypeScript | Java | Python ]
  • Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. associated pull-request, stackoverflow, gitter, etc)

@mhuebner
Copy link

Please have a look at #3081 as well

@Doug-AWS
Copy link
Contributor Author

Nevermind. I figured it out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants