This repository has been archived by the owner on Jun 15, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
17 changed files
with
392 additions
and
822 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
*Issue #, if available:* | ||
|
||
*Description of changes:* | ||
|
||
|
||
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice. | ||
*Issue #, if available:* | ||
|
||
*Description of changes:* | ||
|
||
|
||
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
|
||
The documentation is made available under the Creative Commons Attribution-ShareAlike 4.0 International License. See the LICENSE file. | ||
|
||
The sample code within this documentation is made available under a modified MIT license. See the LICENSE-SAMPLECODE file. | ||
The sample code within this documentation is made available under the MIT-0 license. See the LICENSE-SAMPLECODE file. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,92 +1,47 @@ | ||
.. Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
## [Developer guide](doc_source/index.adoc) for version 2.x of the AWS SDK for Java | ||
|
||
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 | ||
International License (the "License"). You may not use this file except in compliance with the | ||
License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/. | ||
This is the open source version of the developer guide for version 2.x of the Amazon Web Services (AWS) SDK for Java. | ||
|
||
This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, | ||
either express or implied. See the License for the specific language governing permissions and | ||
limitations under the License. | ||
To view this documentation, start with the [index](doc_source/index.adoc). | ||
|
||
########################### | ||
aws-java-developer-guide-v2 | ||
########################### | ||
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). | ||
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. | ||
|
||
This repository contains source content for the official `AWS Java Developer Guide`_. The source | ||
code for the `AWS SDK for Java 2.x`_ is also on GitHub, at https://github.com/aws/aws-sdk-java-v2/. | ||
The GitHub repository for version 2.x of the AWS SDK for Java is at https://github.com/aws/aws-sdk-java-v2. | ||
|
||
The guide content is written in reStructuredText_ and built using Sphinx_. It relies upon content | ||
which is provided in the AWS documentation team's `shared content`_ and `SDK examples`_ | ||
repositories. | ||
## Recent updates | ||
|
||
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. | ||
|
||
Reporting issues | ||
================ | ||
## Reporting issues | ||
|
||
You can use the Issues_ section of this repository to report problems in the documentation. *When | ||
submitting an issue, please indicate*: | ||
You can use the Issues section of this repository to report problems in the documentation. When submitting an issue, please indicate: | ||
|
||
* what page (a URL or filename is best) the issue occurs on. | ||
* What page the issue occurs on; a URL or filename is best. | ||
* What the issue is, using as much detail as you can provide. | ||
* The issue might be simple. For example: "The page has a typo; the word 'complie' in the third paragraph should be 'compile'." | ||
* 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. | ||
|
||
* what the issue is, using as much detail as you can provide. For many issues, this might be as | ||
simple as "The page has a typo; the word 'complie' in the third paragraph shoud be 'compile'." If | ||
the issue is more complex, please describe it with enough detail that it's clear to the AWS | ||
documentation team what the problem is. | ||
## Contributing fixes and updates | ||
|
||
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/). | ||
|
||
Contributing fixes and updates | ||
============================== | ||
## Code examples in the documentation | ||
|
||
To contribute your own documentation fixes or updates, please use the Github-standard procedures for | ||
`forking the repository`_ and submitting a `pull request`_. | ||
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). | ||
|
||
Note that many common substitutions_ and extlinks_ found in these docs are sourced from the `shared | ||
content`_ repository--if you see a substitution used that is not declared at the top of the source | ||
file or in the ``_includes.txt`` file, then it is probably defined in the shared content. | ||
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! | ||
|
||
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). | ||
|
||
Code examples in the documentation | ||
---------------------------------- | ||
## Copyright and license | ||
|
||
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/java>`_. Full | ||
code and build files are included, so you can build and run any of the provided examples yourself. | ||
All content in this repository, unless otherwise stated, is Copyright Amazon.com, Inc. or its affiliates. All rights reserved. | ||
|
||
In addition to examples in Java, 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! | ||
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. | ||
|
||
The code examples are provided under the *Apache 2.0* open source license. See the example | ||
repository's `README <https://github.com/awsdocs/aws-doc-sdk-examples/blob/master/README.rst>`_ for | ||
more details. | ||
## License summary | ||
|
||
The documentation is made available under the Creative Commons Attribution-ShareAlike 4.0 International License. See the LICENSE file. | ||
|
||
Copyright and license | ||
===================== | ||
|
||
All content in this repository, unless otherwise stated, is Copyright ©, Amazon Web | ||
Services, Inc. or its affiliates. All rights reserved. | ||
|
||
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. | ||
|
||
.. ================================================================================= | ||
.. Links used in the README. For sanity's sake, keep this list sorted alphabetically | ||
.. ================================================================================= | ||
|
||
.. _`available sphinx builders`: http://www.sphinx-doc.org/en/stable/builders.html | ||
.. _`aws java developer guide`: http://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/welcome.html | ||
.. _`aws sdk for java`: https://aws.amazon.com/sdk-for-java/ | ||
.. _`forking the repository`: https://help.github.com/articles/fork-a-repo/ | ||
.. _`pull request`: https://help.github.com/articles/using-pull-requests/ | ||
.. _`shared content`: https://github.com/awsdocs/aws-doc-shared-content | ||
.. _`sdk examples`: https://github.com/awsdocs/aws-doc-sdk-examples | ||
.. _extlinks: http://www.sphinx-doc.org/en/stable/ext/extlinks.html | ||
.. _issues: https://github.com/awsdocs/aws-java-developer-guide/issues | ||
.. _restructuredtext: http://docutils.sourceforge.net/rst.html | ||
.. _sphinx: http://www.sphinx-doc.org/en/stable/ | ||
.. _substitutions: http://www.sphinx-doc.org/en/stable/rest.html#substitutions | ||
The sample code within this documentation is made available under the MIT-0 license. See the LICENSE-SAMPLECODE file. |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.