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: address doc linter findings #731

Merged
merged 3 commits into from
Aug 31, 2023
Merged

chore: address doc linter findings #731

merged 3 commits into from
Aug 31, 2023

Conversation

ajewellamz
Copy link
Contributor

Issue #, if available:

Description of changes:

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

Check any applicable:

  • Were any files moved? Moving files changes their URL, which breaks all hyperlinks to the files.

@ajewellamz ajewellamz requested a review from a team as a code owner August 31, 2023 15:59
@ajewellamz ajewellamz changed the title chore: does CI even pass? chore: Let CI pass Aug 31, 2023
## Security issue notifications
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.


Copy link
Contributor Author

Choose a reason for hiding this comment

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

I moved this to a) match better other such files and b) because I had to take the anchor out of the link in README.rst because sphinx couldn't see it.

Copy link
Contributor

Choose a reason for hiding this comment

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

nit: I've always thought this should be in the README outright,
but that's a personal view.

Copy link
Contributor

@texastony texastony left a comment

Choose a reason for hiding this comment

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

LGTM,
but please change the title of this PR or
when you squash, name the commit
chore: address doc linter findings
or something more specific than "Let CI pass"

## Security issue notifications
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.


Copy link
Contributor

Choose a reason for hiding this comment

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

nit: I've always thought this should be in the README outright,
but that's a personal view.

Copy link
Contributor

Choose a reason for hiding this comment

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

nit: I am surprised this needed changing

@ajewellamz ajewellamz changed the title chore: Let CI pass chore: address doc linter findings Aug 31, 2023
@ajewellamz ajewellamz merged commit 65abd6a into master Aug 31, 2023
82 checks passed
@ajewellamz ajewellamz deleted the just-a-test branch August 31, 2023 17:42
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.

2 participants