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

Update links #5

Merged
merged 5 commits into from
Oct 2, 2019
Merged

Update links #5

merged 5 commits into from
Oct 2, 2019

Conversation

mattsb42-aws
Copy link
Member

Description of changes:

  • Applied semantic newlines
  • Added links to API docs
  • Reformatted links to source
  • Added links to product docs for ESDK and DDBEC

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

@mattsb42-aws mattsb42-aws requested a review from a team September 28, 2019 02:10
@mattsb42-aws
Copy link
Member Author

@seebees do we have API docs links for the JS projects here?

@mattsb42-aws
Copy link
Member Author

@SalusaSecondus do we have any API docs for ACCP?

README.md Outdated
- [Java](https://github.com/aws/aws-encryption-sdk-java)
- [Javascript (Beta)](https://github.com/awslabs/aws-encryption-sdk-javascript)
- [Python](https://github.com/aws/aws-encryption-sdk-python/)
- Product Documentation

Choose a reason for hiding this comment

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

Suggested change
- Product Documentation
Product Documentation

Copy link
Member Author

@mattsb42-aws mattsb42-aws Sep 30, 2019

Choose a reason for hiding this comment

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

The Product Documentation entries are intentionally separate list entries.
These are the docs that @juneb owns on https://docs.aws.amazon.com

I don't love the name "Product Documentation", but it was the best I could come up with. If you have any better ideas for what to call that, I'm open to suggestions.

Choose a reason for hiding this comment

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

I second that Product Documentation isn't the best name. May be we can call it AWS Encryption SDK Documents?

Copy link
Member Author

Choose a reason for hiding this comment

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

Well, it's already in the "AWS Encryption SDK" section.
Maybe just call it what it says it is? Developer Guide

README.md Show resolved Hide resolved

# Documentation
- [AWS Crypto Tools Documentation](https://docs.aws.amazon.com/aws-crypto-tools/?id=docs_gateway)
# Documentation

Choose a reason for hiding this comment

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

What documentation are we referring to here?

Copy link
Member Author

Choose a reason for hiding this comment

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

This is a good point. With distributing the product doc links into the specific products, this section name makes less sense. @ragona any ideas?

@seebees
Copy link
Contributor

seebees commented Sep 30, 2019

@mattsb42-aws we have not produced API style docs on a github.io page for the JavaScript ESDK yet

@mattsb42-aws mattsb42-aws merged commit 56521e3 into aws:master Oct 2, 2019
@mattsb42-aws mattsb42-aws deleted the links branch October 2, 2019 19:22
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