Skip to content
The open source version of the AWS SDK for PHP developer Guide. You can submit feedback & requests for changes by submitting issues in this repo or by making proposed changes & submitting a pull request.
Branch: master
Clone or download
SCalwas Fix minor typos
Merge pull request #67 from awsdocs/typos
Latest commit 1fb39fb Jul 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
doc_source Fix minor typos Jul 19, 2019
.gitignore Add doc_output and venv to .gitignore Jun 13, 2019
CODE_OF_CONDUCT.md updating copyright to 2019 Jan 2, 2019
CONTRIBUTING.md updating copyright to 2019 Jan 2, 2019
LICENSE Creating initial file from template Mar 2, 2018
LICENSE-SAMPLECODE updating Copyright date Jan 9, 2019
LICENSE-SUMMARY updating Copyright date Jan 9, 2019
Makefile Updating copyright to 2019 Jan 2, 2019
README.rst Updating copyright to 2019 Jan 2, 2019
build_docs.py Update build_docs.py to remove build_dependencies directory Jun 26, 2019
dependencies.txt updating copyright to 2019 Jan 2, 2019

README.rst

aws-PHP-developer-guide

This repository contains source content for the official AWS PHP v3 Developer Guide. The source code for the AWS SDK for PHP is also on GitHub, at https://github.com/aws/aws-sdk-PHP/.

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.

Reporting issues

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.

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 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.

Building the documentation

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:

  1. Make sure that you have downloaded and installed Sphinx.

  2. 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 will then generate output into the doc_output directory.

Code examples in the documentation

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 PHP, 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.

Copyright and license

All content in this repository, unless otherwise stated, is Copyright © 2010-2019, 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.

You can’t perform that action at this time.