Skip to content

Conversation

hoffa
Copy link
Contributor

@hoffa hoffa commented Nov 22, 2022

Issue #, if available

#1133

Description of changes

Adds scaffolding so we can support documentation in SAM template hover tooltips.

Will need many more changes but serves as a starting point.

Description of how you validated changes

Checklist

  • Adheres to the development guidelines
  • Add/update unit tests using:
  • Add/update integration tests
  • Update documentation
  • Verify transformed template deploys and application functions as expected
  • Do these changes include any template validations?
    • Did the newly validated properties support intrinsics prior to adding the validations? (If unsure, please review Intrinsic Functions before proceeding).
      • Does the pull request ensure that intrinsics remain functional with the new validations?

Examples?

Please reach out in the comments, if you want to add an example. Examples will be
added to sam init through https://github.com/awslabs/aws-sam-cli-app-templates/

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

@hoffa hoffa requested a review from a team as a code owner November 22, 2022 22:07
Copy link
Contributor

@awood45 awood45 left a comment

Choose a reason for hiding this comment

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

To help me understand - are we picking these at semi-random as a sample, or is there a reason we only cover these two parameters?

@hoffa
Copy link
Contributor Author

hoffa commented Nov 22, 2022

To help me understand - are we picking these at semi-random as a sample, or is there a reason we only cover these two parameters?

They're arbitrary to make sure it somewhat works. We'll need some way to mass-import the current documentation.

@hoffa hoffa merged commit 062636f into aws:develop Nov 22, 2022
@hoffa hoffa deleted the add-md-description branch November 22, 2022 22:21
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

Successfully merging this pull request may close these issues.

4 participants