|
1 | | -.. Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. |
| 1 | +## [Developer guide](doc_source/index.md) for the AWS SDK for PHP |
2 | 2 |
|
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 the AWS SDK for PHP. |
6 | 4 |
|
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 | +**NOTE**: The default branch for this repo has changed to `main`. |
| 6 | +If you have cloned the previous default branch, please update your local repo to use the `main` branch. |
10 | 7 |
|
11 | | -######################## |
12 | | -aws-PHP-developer-guide |
13 | | -######################## |
| 8 | +To view this documentation, start with the [index](doc_source/index.md). |
14 | 9 |
|
15 | | -This repository contains source content for the official `AWS PHP v3 Developer Guide`_. The source |
16 | | -code for the `AWS SDK for PHP`_ is also on GitHub, at https://github.com/aws/aws-sdk-PHP/. |
| 10 | +This repository contains the open source version of the official [AWS SDK for PHP Developer Guide](https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/welcome.html). |
| 11 | + |
| 12 | +The GitHub repository for the AWS SDK for PHP is at https://github.com/aws/aws-sdk-PHP/. |
17 | 13 |
|
18 | 14 | The guide content is written Markdown. It relies upon content |
19 | 15 | which is provided in the AWS documentation team's `shared content`_ and `SDK examples`_ |
20 | 16 | repositories. |
21 | 17 |
|
| 18 | +## Recent updates |
22 | 19 |
|
23 | | -Reporting issues |
24 | | -================ |
25 | | - |
26 | | -You can use the Issues_ section of this repository to report problems in the documentation. *When |
27 | | -submitting an issue, please indicate*: |
28 | | - |
29 | | -* what page (a URL or filename is best) the issue occurs on. |
30 | | - |
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. |
35 | | - |
36 | | - |
37 | | -Contributing fixes and updates |
38 | | -============================== |
39 | | - |
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`_. |
42 | | - |
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. |
46 | | - |
47 | | - |
48 | | -Building the documentation |
49 | | --------------------------- |
50 | | - |
51 | | -If you are planning to contribute to the docs, you should build your changes and review them before |
52 | | -submitting your pull request. |
53 | | - |
54 | | -**To build the docs:** |
55 | | - |
56 | | -1. Make sure that you have downloaded and installed Sphinx_. |
57 | | -2. Run the ``build_docs.py`` script in the repository's root directory. |
58 | | - |
59 | | - ``build_docs.py`` can take any of the `available Sphinx builders`_ as its argument. For example, |
60 | | - to build the docs into a single HTML page, you can use the ``singlehtml`` target, like so:: |
61 | | - |
62 | | - python build_docs.py singlehtml |
63 | | - |
64 | | -The build process will automatically download a snapshot of its dependencies, combine them in the |
65 | | -``doc_build`` directory and will then generate output into the ``doc_output`` directory. |
| 20 | +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.md) topic. |
66 | 21 |
|
| 22 | +## Reporting issues |
67 | 23 |
|
68 | | -Code examples in the documentation |
69 | | ----------------------------------- |
| 24 | +You can use the Issues section of this repository to report problems in the documentation. When submitting an issue, please indicate: |
70 | 25 |
|
71 | | -The code examples featured in this documentation can be found in a separate repository: |
72 | | -`aws-doc-sdk-examples <https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/php/example_code>`_. Full |
73 | | -code and build files are included, so you can build and run any of the provided examples yourself. |
| 26 | + * What page the issue occurs on; a URL or filename is best. |
| 27 | + * What the issue is, using as much detail as you can provide. |
| 28 | + * The issue might be simple. For example: "The page has a typo; the word 'complie' in the third paragraph should be 'compile'." |
| 29 | + * 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. |
74 | 30 |
|
75 | | -In addition to examples in PHP, you'll also find examples for each of the other AWS SDKs. If you |
76 | | -find issues with any of the examples, you can submit issues or fork the repository and submit a pull |
77 | | -request! |
| 31 | +## Contributing fixes and updates |
78 | 32 |
|
79 | | -The code examples are provided under the *Apache 2.0* open source license. See the example |
80 | | -repository's `README <https://github.com/awsdocs/aws-doc-sdk-examples/blob/master/README.rst>`_ for |
81 | | -more details. |
| 33 | +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/). |
82 | 34 |
|
| 35 | +## Copyright and license |
83 | 36 |
|
84 | | -Copyright and license |
85 | | -===================== |
| 37 | +All content in this repository, unless otherwise stated, is Copyright Amazon.com, Inc. or its affiliates. All rights reserved. |
86 | 38 |
|
87 | | -All content in this repository, unless otherwise stated, is |
88 | | -Copyright ©, Amazon Web Services, Inc. or its affiliates. All rights reserved. |
| 39 | +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. |
89 | 40 |
|
90 | | -Except where otherwise noted, this work is licensed under a `Creative Commons |
91 | | -Attribution-NonCommercial-ShareAlike 4.0 International License |
92 | | -<http://creativecommons.org/licenses/by-nc-sa/4.0/>`_ (the "License"). Use the preceding link for a |
93 | | -human-readable summary of the license terms. The full license text is available at: |
94 | | -http://creativecommons.org/licenses/by-nc-sa/4.0/legalcode and in the LICENSE file accompanying this |
95 | | -repository. |
| 41 | +## License summary |
96 | 42 |
|
97 | | -.. ================================================================================= |
98 | | -.. Links used in the README. For sanity's sake, keep this list sorted alphabetically |
99 | | -.. ================================================================================= |
| 43 | +The documentation is made available under the Creative Commons Attribution-ShareAlike 4.0 International License. See the LICENSE file. |
100 | 44 |
|
101 | | -.. _`available sphinx builders`: http://www.sphinx-doc.org/en/stable/builders.html |
102 | | -.. _`aws PHP v3 developer guide`: https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/welcome.html |
103 | | -.. _`aws sdk for PHP`: https://aws.amazon.com/sdk-for-php/ |
104 | | -.. _`forking the repository`: https://help.github.com/articles/fork-a-repo/ |
105 | | -.. _`pull request`: https://help.github.com/articles/using-pull-requests/ |
106 | | -.. _`shared content`: https://github.com/awsdocs/aws-doc-shared-content |
107 | | -.. _`sdk examples`: https://github.com/awsdocs/aws-doc-sdk-examples |
108 | | -.. _extlinks: http://www.sphinx-doc.org/en/stable/ext/extlinks.html |
109 | | -.. _issues: https://github.com/awsdocs/aws-php-developers-guide/issues |
110 | | -.. _restructuredtext: http://docutils.sourceforge.net/rst.html |
111 | | -.. _sphinx: http://www.sphinx-doc.org/en/stable/ |
112 | | -.. _substitutions: http://www.sphinx-doc.org/en/stable/rest.html#substitutions |
| 45 | +The sample code within this documentation is made available under the MIT-0 license. See the LICENSE-SAMPLECODE file. |
0 commit comments