Comments (5)
One of the ways we're working on addressing this is in the form of end-user documentation. You can see our current progress on the docs branch: https://github.com/aws/aws-sdk-php/tree/docs/docs. Do docs like that help?
from aws-sdk-php.
Looks like a good start. I'm not familiar with RST files - idea here your gonna run them through a compiler of somesort and spit out HTML that will be hosted on github pages or something?
Whatever tool you do use, I think it would be pretty valuable to choose one that is easy for people to contribute to - so people like myself who would be willing to contribute can easily send pull requests.
Also direct contextual (faq.blah#sometopic) linking from the api docs to these docs would be sweet. That way you just PHPdoc the link when your writing the SDK - then you can link from something like http://docs.amazonwebservices.com/aws-sdk-php-2/latest/class-Aws.DynamoDb.DynamoDbClient.html#_scan to http://newurl.com/service-dynamo.html#scanExample
just my 2c.
from aws-sdk-php.
Yeah, we'll generate these docs and host them somewhere. The intent of using reStructuredText and Sphinx is that it will be easy to contribute to them.
We'll see about how to best link between docs. Thanks for your feedback.
from aws-sdk-php.
+1 for this.
The new SDK is awesome
from aws-sdk-php.
Our user guide documentation is now hosted at http://docs.aws.amazon.com/aws-sdk-php-2/guide/latest/index.html. This documentation includes various examples for common tasks. We will continue to update these guides and work to improve our API documentation.
Please note that our documentation is open source, and we are happy to accept pull requests that help to improve them: https://github.com/aws/aws-sdk-php/tree/master/docs
from aws-sdk-php.
Related Issues (20)
- no longer possible to use ElasticMQ since 3.286.2 HOT 3
- Unable to override IMDSv2 service URL HOT 3
- Use of SSO roles for PHP CLI HOT 1
- Incorrect argument type HOT 5
- fprintf(): supplied resource is not a valid stream resource HOT 4
- SignatureV4 mismatch on some requests HOT 7
- Deprecated: Using ${var} in strings is deprecated HOT 3
- Support 'OriginationNumber' when sending SMS. HOT 1
- Exception thrown in synchronous call "bleeds over" to asynchronous call HOT 3
- IRSA for Kubernetes not working HOT 3
- Argument 4 passed to Aws\Exception\AwsException::__construct() must be an instance of Exception or null HOT 3
- verifyDomainDkim method of SES Client returns validation error HOT 4
- Yum package
- InstanceProfile credentials provider causing open_basedir restriction error since 3.297.0 HOT 2
- Aws SQS: VisibilityTimeout value is zero and type is string instead integer HOT 5
- What version should I specify for MediaPackage and MediaPackageVod client? HOT 3
- PostObjectV4 with Custom Domain HOT 5
- File paths are not safe for Windows HOT 2
- fopen() throws Error executing "GetObject" HOT 1
- GetObject() command @http stream issue HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from aws-sdk-php.