Skip to content

Conversation

hoffa
Copy link
Contributor

@hoffa hoffa commented Nov 24, 2022

Issue #, if available

#1133

Description of changes

bin/parse_docs.py aws-sam-developer-guide/doc_source > samtranslator/schema/docs.json

Screen Shot 2022-11-24 at 09 26 00

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 changed the title Docs import feat: add docs to JSON schmea Nov 24, 2022
@hoffa hoffa changed the title feat: add docs to JSON schmea feat: add docs to JSON schema Nov 24, 2022
@hoffa hoffa changed the title feat: add docs to JSON schema feat: add docs to AWS::Serverless::Function JSON schema Nov 24, 2022
@hoffa hoffa changed the title feat: add docs to AWS::Serverless::Function JSON schema feat: more schema docs scaffolding + AWS::Serverless::Function Nov 24, 2022
@hoffa hoffa marked this pull request as ready for review November 24, 2022 07:53
@hoffa hoffa requested a review from a team as a code owner November 24, 2022 07:53
@hoffa hoffa changed the title feat: more schema docs scaffolding + AWS::Serverless::Function feat: more docs scaffolding + AWS::Serverless::Function Nov 24, 2022
Copy link
Contributor

@aaythapa aaythapa left a comment

Choose a reason for hiding this comment

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

LGTM! Does the hover tooltips only work in VSCode or in any IDE?

@hoffa
Copy link
Contributor Author

hoffa commented Nov 24, 2022

LGTM! Does the hover tooltips only work in VSCode or in any IDE?

I only know of VS Code. But it should work if the IDE supports YAML with JSON schema, and tooltips based on description/markdownDescription.

@hoffa hoffa merged commit 4d165c8 into aws:develop Nov 24, 2022
@hoffa hoffa deleted the docs-import branch November 24, 2022 17:43
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.

3 participants