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 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.
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 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.
To contribute your own documentation fixes or updates, please use the Github-standard procedures for forking the repository and submitting a pull request.
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.
If you are planning to contribute to the docs, you should build your changes and review them before submitting your pull request.
To build the docs:
Make sure that you have downloaded and installed Sphinx.
Run the
build_docs.pyscript in the repository's root directory.build_docs.pycan take any of the available Sphinx builders as its argument. For example, to build the docs into a single HTML page, you can use thesinglehtmltarget, like so:python build_docs.py singlehtml
The build process will automatically download a snapshot of its dependencies, combine them in the
doc_build directory and will then generate output into the doc_output directory.
The code examples featured in this documentation can be found in a separate repository: aws-doc-sdk-examples. Full code and build files are included, so you can build and run any of the provided examples yourself.
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!
The code examples are provided under the Apache 2.0 open source license. See the example repository's README for more details.
All content in this repository, unless otherwise stated, is Copyright © 2010-2017, 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 (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.