aws-ruby-developer-guide

This repository contains the source for the official AWS SDK for Ruby Developer Guide. It provides information about how to install, set up, and use the AWS SDK for Ruby to create Ruby applications that use AWS services.

The guide content is written in reStructuredText and built using Sphinx. It relies on content that is provided in the AWS documentation team's shared content and SDK examples repositories.

Reporting issues

You can use the Issues. section of this repository to report problems in the documentation. When submitting an issue, please indicate:

The page (a URL or file name is best) that 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.

Contributing fixes and updates

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 isn't declared at the top of the source file or in the _includes.txt file, then it's probably defined in the shared content.

Building the documentation

If you're planning to contribute to the docs, you should build your changes and review them before submitting your pull request.

To build the docs

Be sure that you have downloaded and installed Sphinx.
Run the build_docs.py script in the repository's root directory.

build_docs.py can take any of the available Sphinx builders as its argument. For example, to build the docs into a single HTML page, you can use the singlehtml target, 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 then generate output into the doc_output directory.

Code examples in the documentation

You can find the code examples featured in this documentation 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 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. See the example repository's README for more details.

aasmith / aws-ruby-developer-guide Goto Github PK