aws-deadline / deadline-cloud

Multi-purpose library and command line tool that implements functionality to support applications using AWS Deadline Cloud.
Apache License 2.0
25 stars 28 forks source link

docs: Fixing broken links in ReadMe file and minor punctuation #458

Closed rena-cheng closed 3 days ago

rena-cheng commented 5 days ago

Fixes: N/A

What was the problem/requirement? (What/Why)

I found some links that were broken in the ReadMe file on this package so I'm submitting this PR to fix them.

While I was doing that I decided to proofread the ReadMe file a little bit and decided to fix some minor punctuation/grammar errors, so that everything reads a little better.

What was the solution? (How)

Figured out what were the correct links and fixed them.

What is the impact of this change?

Makes our ReadMe look better. Also less frustration for anyone who was trying to access those links.

How was this change tested?

Not needed. I did ensure that the links were working again and that the formatting looked correct in my own fork.

See DEVELOPMENT.md for information on running tests.

Was this change documented?

N/A

Does this PR introduce new dependencies?

N/A

This library is designed to be integrated into third-party applications that have bespoke and customized deployment environments. Adding dependencies will increase the chance of library version conflicts and incompatabilities. Please evaluate the addition of new dependencies. See the Dependencies section of DEVELOPMENT.md for more details.

Is this a breaking change?

N/A

A breaking change is one that modifies a public contract in a way that is not backwards compatible. See the Public Contracts section of the DEVELOPMENT.md for more information on the public contracts.

If so, then please describe the changes that users of this package must make to update their scripts, or Python applications.

Does this change impact security?

N/A


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

sonarcloud[bot] commented 4 days ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud