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

Minor syntax adjustments for select README files #1018

Merged
merged 2 commits into from
Oct 11, 2023

Conversation

hayesry
Copy link
Contributor

@hayesry hayesry commented Oct 11, 2023

Issue #, if available: N/a

Description of changes:
This changeset applies minor syntax edits to the README files associated with the following constructs:

  • aws-eventbridge-kinesisfirehose-s3
  • aws-lambda-kendra

These changes are necessary due to syntax limitations with the documentation converter used to publish the API Reference library at https://docs.aws.amazon.com/solutions/latest/constructs. These limitations specifically include:

  • Incompatibilities with placing bullet lists within table cells.
  • Markdown-to-XML conversion requirements for a newline before a section.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@aws-solutions-constructs-team
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: githubautobuild-for-cdk-v2
  • Commit ID: caf9f90
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@aws-solutions-constructs-team
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: githubautobuild-for-cdk-v2
  • Commit ID: d5fa812
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@biffgaut biffgaut merged commit 8f76f0c into main Oct 11, 2023
1 check passed
@biffgaut biffgaut deleted the docs/hayesry/10-11-2023 branch October 11, 2023 18:32
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