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

docs(opensearchservice): fix broken markdown link #29525

Merged
merged 2 commits into from
Mar 18, 2024
Merged

docs(opensearchservice): fix broken markdown link #29525

merged 2 commits into from
Mar 18, 2024

Conversation

tmokmss
Copy link
Contributor

@tmokmss tmokmss commented Mar 18, 2024 •
edited
Loading

Reason for this change

Links in the opensearch doc are in invalid markdown.

For example:

image

Description of changes

Removed a newline character between [] and ().

Description of how you validated changes

Preview in VSCode.

Checklist

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

@aws-cdk-automation aws-cdk-automation requested a review from a team March 18, 2024 07:28
@github-actions github-actions bot added p2 star-contributor [Pilot] contributed between 25-49 PRs to the CDK labels Mar 18, 2024
aws-cdk-automation
aws-cdk-automation previously requested changes Mar 18, 2024
View reviewed changes
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

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

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@tmokmss tmokmss changed the title doc(aws-opensearchservice): fix broken markdown link docs(opensearchservice): fix broken markdown link Mar 18, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review March 18, 2024 07:32

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Mar 18, 2024
paulhcsun
paulhcsun approved these changes Mar 18, 2024
View reviewed changes
Copy link
Contributor

@paulhcsun paulhcsun left a comment

Choose a reason for hiding this comment

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

Nice catch, thanks @tmokmss!

paulhcsun
paulhcsun previously approved these changes Mar 18, 2024
View reviewed changes
Copy link
Contributor

@paulhcsun paulhcsun left a comment

Choose a reason for hiding this comment

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

Nice catch, thanks @tmokmss!

@mergify Mergify
Copy link
Contributor

mergify bot commented Mar 18, 2024

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot dismissed paulhcsun’s stale review March 18, 2024 17:24

Pull request has been modified.

@aws-cdk-automation aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Mar 18, 2024
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 485cb84
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@mergify Mergify
Copy link
Contributor

mergify bot commented Mar 18, 2024

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit 5142cba into aws:main Mar 18, 2024
14 checks passed
@tmokmss tmokmss deleted the fix_aoss_doc branch March 19, 2024 00:37
@github-actions github-actions bot mentioned this pull request Mar 25, 2024
Closed
ahammond pushed a commit to ahammond/aws-cdk that referenced this pull request Mar 26, 2024
@tmokmss @ahammond
docs(opensearchservice): fix broken markdown link (aws#29525)
7f65470 
### Reason for this change

Links in the [opensearch doc](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_opensearchservice.CapacityConfig.html) are in invalid markdown.

For example:

![image](https://github.com/aws/aws-cdk/assets/7490655/2879b0cf-a462-455c-bb24-24dea79052e6)


### Description of changes
Removed a newline character between `[]` and `()`.

### Description of how you validated changes

Preview in VSCode.

### Checklist
- [X] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions github-actions bot mentioned this pull request Apr 1, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@paulhcsun paulhcsun paulhcsun approved these changes

@aws-cdk-automation aws-cdk-automation aws-cdk-automation left review comments

Assignees
No one assigned
Labels
p2 star-contributor [Pilot] contributed between 25-49 PRs to the CDK
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@tmokmss @aws-cdk-automation @paulhcsun