Updated Branches: refs/heads/trunk a8aff7e19 -> 33f5722eb
docs: Update getting started page. Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/b6c2530a Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/b6c2530a Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/b6c2530a Branch: refs/heads/trunk Commit: b6c2530a4396336957ed2c191909849492b545af Parents: a8aff7e Author: Tomaz Muraus <[email protected]> Authored: Sun Nov 17 19:56:20 2013 +0100 Committer: Tomaz Muraus <[email protected]> Committed: Sun Nov 17 19:56:20 2013 +0100 ---------------------------------------------------------------------- docs/getting_started.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/libcloud/blob/b6c2530a/docs/getting_started.rst ---------------------------------------------------------------------- diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 472f4a6..fbfb310 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -51,6 +51,12 @@ with any of the Libcloud drivers. driver = cls('my username', 'my api key') +Keep in mind that some drivers take additional arguments such as ``region`` +and ``api_version``. + +For more information on which arguments you can pass to your provider driver, +see provider-specific documentation and the driver docstrings. + 3. Start using the driver .. sourcecode:: python @@ -78,3 +84,14 @@ on the :doc:`Compute Examples </compute/examples>` page. Where to go from here? ---------------------- + +The best thing to do after understanding the basic driver work-flow is to visit +the documentation chapter for the API you are interested in (:doc:`Compute </compute/index>`, :doc:`Object Storage </storage/index>`, +:doc:`Load Balancer </loadbalancer/index>`, :doc:`DNS </dns/index>`). Chapter +for each API explains some basic terminology and things you need to know to +make an effective use of that API. + +After you have a good grasp of those basic concepts, you are encouraged to +check the driver specific documentation (if available) and usage examples. If +the driver specific documentation for the provider you are interested in is +not available yet, you are encouraged to check docstrings for that driver.
