[libcloudproviders/wip/documentation-update: 7/7] docs: add documentation on general usage and cloudprovidersd



commit fb3e6f8a56a734eb8b1ac19563c8b35edcf837d8
Author: Julius Härtl <jus bitgrid net>
Date:   Mon Sep 4 13:00:46 2017 +0200

    docs: add documentation on general usage and cloudprovidersd

 docs/reference/libcloudproviders-docs.xml | 45 +++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
---
diff --git a/docs/reference/libcloudproviders-docs.xml b/docs/reference/libcloudproviders-docs.xml
index 04a9906..10f455b 100644
--- a/docs/reference/libcloudproviders-docs.xml
+++ b/docs/reference/libcloudproviders-docs.xml
@@ -42,8 +42,43 @@
         This part documents libcloudproviders libs.
       </para>
     </partintro>
+
+    <refentry id="libcloudproviders-client" lang="en">
+      <refmeta>
+        <refentrytitle>Implementing support as a cloud provider</refentrytitle>
+      </refmeta>
+      <refnamediv>
+        <refname>Implementing support as a cloud provider</refname>
+      </refnamediv>
+      <refsect1>
+      <para>
+        Cloud providers need to create #CloudProviderAccountExporter objects for
+        every account they like to expose to the API. To provide the account details
+        clients need to listen to the signals provided by the exporter and return
+        their information there.All #CloudProviderAccountExporter objects need to
+        be added to the #CloudProviderExporter by calling cloud_provider_exporter_add_account().
+      </para>
+      </refsect1>
+    </refentry>
     <xi:include href="xml/cloudproviderexporter.xml"/>
     <xi:include href="xml/cloudprovideraccountexporter.xml"/>
+
+    <refentry id="libcloudproviders-integrator" lang="en">
+      <refmeta>
+        <refentrytitle>Integrating cloud providers</refentrytitle>
+      </refmeta>
+      <refnamediv>
+        <refname>Integrating cloud providers</refname>
+      </refnamediv>
+      <refsect1>
+        <para>
+          Integration with cloud providers can be achieved by fetching a list of exported
+          cloud provider accounts using cloud_providers_get_providers(). This function returns
+          a list of #CloudProviderAccount objects that can then be used to obtain details about
+          the accounts.
+        </para>
+      </refsect1>
+    </refentry>
     <xi:include href="xml/cloudproviders.xml"/>
     <xi:include href="xml/cloudprovideraccount.xml"/>
   </reference>
@@ -58,4 +93,14 @@
     <xi:include href="generated-docs-org.freedesktop.CloudProvider.Manager1.xml"/>
   </reference>
 
+  <reference id="cloudprovidersd">
+    <title>cloudproviders daemon</title>
+    <partintro>
+      <para>
+        This part documents cloudproviders service daemon
+      </para>
+    </partintro>
+    <xi:include href="xml/cloudprovidersd.xml"/>
+  </reference>
+
 </book>


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]