Skip to content
This repository was archived by the owner on Jun 15, 2023. It is now read-only.

Commit 9c96733

Browse files
committed
Content updates - 20210810-202826
1 parent a1ecb1a commit 9c96733

17 files changed

+392
-822
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
*Issue #, if available:*
2-
3-
*Description of changes:*
4-
5-
6-
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
1+
*Issue #, if available:*
2+
3+
*Description of changes:*
4+
5+
6+
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,4 @@ If you discover a potential security issue, please notify AWS Security via our [
5353

5454
## Licensing
5555

56-
See the [LICENSE](https://github.com/awsdocs/aws-java-developer-guide-v2/blob/base/LICENSE) file for this project's licensing. We will ask you to confirm the licensing of your contribution. We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
56+
See the [LICENSE](LICENSE) file for this project's licensing. We will ask you to confirm the licensing of your contribution. We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.

LICENSE

100755100644
Lines changed: 153 additions & 152 deletions
Large diffs are not rendered by default.

LICENSE-SAMPLECODE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
1+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
22

33
Permission is hereby granted, free of charge, to any person obtaining a copy of this
44
software and associated documentation files (the "Software"), to deal in the Software

LICENSE-SUMMARY

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
1+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
22

33
The documentation is made available under the Creative Commons Attribution-ShareAlike 4.0 International License. See the LICENSE file.
44

5-
The sample code within this documentation is made available under a modified MIT license. See the LICENSE-SAMPLECODE file.
5+
The sample code within this documentation is made available under the MIT-0 license. See the LICENSE-SAMPLECODE file.

Makefile

Lines changed: 0 additions & 22 deletions
This file was deleted.

README.md

Lines changed: 26 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,92 +1,47 @@
1-
.. Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
1+
## [Developer guide](doc_source/index.adoc) for version 2.x of the AWS SDK for Java
22

3-
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
4-
International License (the "License"). You may not use this file except in compliance with the
5-
License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/.
3+
This is the open source version of the developer guide for version 2.x of the Amazon Web Services (AWS) SDK for Java.
64

7-
This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
8-
either express or implied. See the License for the specific language governing permissions and
9-
limitations under the License.
5+
To view this documentation, start with the [index](doc_source/index.adoc).
106

11-
###########################
12-
aws-java-developer-guide-v2
13-
###########################
7+
This repository contains the open source version of the official [AWS SDK for Java 2.x Developer Guide](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide).
8+
It provides information about how to set up and use the [AWS SDK for Java](https://aws.amazon.com/sdk-for-java) to create Java applications that use AWS.
149

15-
This repository contains source content for the official `AWS Java Developer Guide`_. The source
16-
code for the `AWS SDK for Java 2.x`_ is also on GitHub, at https://github.com/aws/aws-sdk-java-v2/.
10+
The GitHub repository for version 2.x of the AWS SDK for Java is at https://github.com/aws/aws-sdk-java-v2.
1711

18-
The guide content is written in reStructuredText_ and built using Sphinx_. It relies upon content
19-
which is provided in the AWS documentation team's `shared content`_ and `SDK examples`_
20-
repositories.
12+
## Recent updates
2113

14+
You can find out when this guide has had major updates and what those updates were by looking in the [Document History](doc_source/document-history.adoc) topic.
2215

23-
Reporting issues
24-
================
16+
## Reporting issues
2517

26-
You can use the Issues_ section of this repository to report problems in the documentation. *When
27-
submitting an issue, please indicate*:
18+
You can use the Issues section of this repository to report problems in the documentation. When submitting an issue, please indicate:
2819

29-
* what page (a URL or filename is best) the issue occurs on.
20+
* What page the issue occurs on; a URL or filename is best.
21+
* What the issue is, using as much detail as you can provide.
22+
* The issue might be simple. For example: "The page has a typo; the word 'complie' in the third paragraph should be 'compile'."
23+
* The issue might be more complex. If so, please describe it with enough detail so that it's clear to the AWS documentation team what the problem is.
3024

31-
* what the issue is, using as much detail as you can provide. For many issues, this might be as
32-
simple as "The page has a typo; the word 'complie' in the third paragraph shoud be 'compile'." If
33-
the issue is more complex, please describe it with enough detail that it's clear to the AWS
34-
documentation team what the problem is.
25+
## Contributing fixes and updates
3526

27+
To contribute your own documentation fixes or updates, please use standard GitHub procedures for [forking a repository](https://help.github.com/articles/fork-a-repo/) and [submitting a pull request](https://help.github.com/articles/using-pull-requests/).
3628

37-
Contributing fixes and updates
38-
==============================
29+
## Code examples in the documentation
3930

40-
To contribute your own documentation fixes or updates, please use the Github-standard procedures for
41-
`forking the repository`_ and submitting a `pull request`_.
31+
The code examples featured in this documentation can be found in a separate repository: [aws-doc-sdk-examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/javav2/example_code).
4232

43-
Note that many common substitutions_ and extlinks_ found in these docs are sourced from the `shared
44-
content`_ repository--if you see a substitution used that is not declared at the top of the source
45-
file or in the ``_includes.txt`` file, then it is probably defined in the shared content.
33+
In addition to examples in Ruby, you'll also find examples for each of the other AWS SDKs. If you find issues with any of the examples, you can submit Issues or fork the repository and submit a pull request!
4634

35+
The code examples are provided under the Apache 2.0 open source license. For more details, see the example repository's [README](https://github.com/awsdocs/aws-doc-sdk-examples/blob/master/README.rst).
4736

48-
Code examples in the documentation
49-
----------------------------------
37+
## Copyright and license
5038

51-
The code examples featured in this documentation can be found in a separate repository:
52-
`aws-doc-sdk-examples <https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/java>`_. Full
53-
code and build files are included, so you can build and run any of the provided examples yourself.
39+
All content in this repository, unless otherwise stated, is Copyright Amazon.com, Inc. or its affiliates. All rights reserved.
5440

55-
In addition to examples in Java, you'll also find examples for each of the other AWS SDKs. If you
56-
find issues with any of the examples, you can submit issues or fork the repository and submit a pull
57-
request!
41+
Except where otherwise noted, this work is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-nc-sa/4.0/) (the "License"). Use the preceding link for a human-readable summary of the license terms. The full license text is available at: http://creativecommons.org/licenses/by-nc-sa/4.0/legalcode and in the LICENSE file accompanying this repository.
5842

59-
The code examples are provided under the *Apache 2.0* open source license. See the example
60-
repository's `README <https://github.com/awsdocs/aws-doc-sdk-examples/blob/master/README.rst>`_ for
61-
more details.
43+
## License summary
6244

45+
The documentation is made available under the Creative Commons Attribution-ShareAlike 4.0 International License. See the LICENSE file.
6346

64-
Copyright and license
65-
=====================
66-
67-
All content in this repository, unless otherwise stated, is Copyright ©, Amazon Web
68-
Services, Inc. or its affiliates. All rights reserved.
69-
70-
Except where otherwise noted, this work is licensed under a `Creative Commons
71-
Attribution-NonCommercial-ShareAlike 4.0 International License
72-
<http://creativecommons.org/licenses/by-nc-sa/4.0/>`_ (the "License"). Use the preceding link for a
73-
human-readable summary of the license terms. The full license text is available at:
74-
http://creativecommons.org/licenses/by-nc-sa/4.0/legalcode and in the LICENSE file accompanying this
75-
repository.
76-
77-
.. =================================================================================
78-
.. Links used in the README. For sanity's sake, keep this list sorted alphabetically
79-
.. =================================================================================
80-
81-
.. _`available sphinx builders`: http://www.sphinx-doc.org/en/stable/builders.html
82-
.. _`aws java developer guide`: http://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/welcome.html
83-
.. _`aws sdk for java`: https://aws.amazon.com/sdk-for-java/
84-
.. _`forking the repository`: https://help.github.com/articles/fork-a-repo/
85-
.. _`pull request`: https://help.github.com/articles/using-pull-requests/
86-
.. _`shared content`: https://github.com/awsdocs/aws-doc-shared-content
87-
.. _`sdk examples`: https://github.com/awsdocs/aws-doc-sdk-examples
88-
.. _extlinks: http://www.sphinx-doc.org/en/stable/ext/extlinks.html
89-
.. _issues: https://github.com/awsdocs/aws-java-developer-guide/issues
90-
.. _restructuredtext: http://docutils.sourceforge.net/rst.html
91-
.. _sphinx: http://www.sphinx-doc.org/en/stable/
92-
.. _substitutions: http://www.sphinx-doc.org/en/stable/rest.html#substitutions
47+
The sample code within this documentation is made available under the MIT-0 license. See the LICENSE-SAMPLECODE file.

README.rst

Lines changed: 0 additions & 112 deletions
This file was deleted.

0 commit comments

Comments
 (0)