Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Runtimeconfig: prep docs for repo split. #6023

Merged
merged 1 commit into from
Sep 19, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -331,6 +331,7 @@
static_html_pages = [
'datastore/usage.html',
'bigquery/usage.html',
'runtimeconfig/usage.html',
'spanner/usage.html',
]

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
OSLogin <oslogin/index>
Redis <redis/index>
Resource Manager <resource-manager/index>
Runtime Configuration <runtimeconfig/usage>
Runtime Configuration <runtimeconfig/index>
Security Scanner <websecurityscanner/index>
Spanner <spanner/index>
Speech <speech/index>
Expand Down
1 change: 1 addition & 0 deletions docs/runtimeconfig
1 change: 0 additions & 1 deletion docs/runtimeconfig/changelog.md

This file was deleted.

37 changes: 0 additions & 37 deletions docs/runtimeconfig/usage.rst

This file was deleted.

92 changes: 58 additions & 34 deletions runtimeconfig/README.rst
Original file line number Diff line number Diff line change
@@ -1,59 +1,83 @@
Python Client for Google Cloud RuntimeConfig
============================================

Python idiomatic client for `Google Cloud RuntimeConfig`_

.. _Google Cloud RuntimeConfig: https://cloud.google.com/deployment-manager/runtime-configurator/

|alpha| |pypi| |versions|

- `Documentation`_
The `Google Cloud RuntimeConfig`_ API enables developers to dynamically
configure and expose variables through Google Cloud Platform. In addition, you
can also set Watchers and Waiters that will watch for changes to your data and
return based on certain conditions.

.. _Documentation: http://googlecloudplatform.github.io/google-cloud-python/
- `Client Library Documentation`_
- `Product Documentation`_

.. |alpha| image:: https://img.shields.io/badge/status-alpha-orange.svg
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-runtimeconfig.svg
:target: https://pypi.org/project/google-cloud-runtimeconfig/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-runtimeconfig.svg
:target: https://pypi.org/project/google-cloud-runtimeconfig/
.. _Google Cloud RuntimeConfig: https://cloud.google.com/deployment-manager/runtime-configurator/
.. _Client Library Documentation: http://googlecloudplatform.github.io/google-cloud-python/runtimeconfig/index.html
.. _Product Documentation: https://cloud.google.com/deployment-manager/runtime-configurator/reference/rest/

**This client library is currently in alpha and may be subject to change.**

Quick Start
-----------

::
In order to use this library, you first need to go through the following steps:

$ pip install --upgrade google-cloud-runtimeconfig
1. `Select or create a Cloud Platform project.`_
2. `Enable billing for your project.`_
3. `Enable the Google Cloud Datastore API.`_
4. `Setup Authentication.`_

For more information on setting up your Python development environment,
such as installing ``pip`` and ``virtualenv`` on your system, please refer
to `Python Development Environment Setup Guide`_ for Google Cloud Platform.
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Enable the Google Cloud Datastore API.: https://cloud.google.com/runtimeconfig
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/latest/core/auth.html

.. _Python Development Environment Setup Guide: https://cloud.google.com/python/setup
Installation
~~~~~~~~~~~~

Authentication
--------------
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
create isolated Python environments. The basic problem it addresses is one of
dependencies and versions, and indirectly permissions.

With ``google-cloud-python`` we try to make authentication as painless as
possible. Check out the `Authentication section`_ in our documentation to
learn more. You may also find the `authentication document`_ shared by all
the ``google-cloud-*`` libraries to be helpful.
With `virtualenv`_, it's possible to install this library without needing system
install permissions, and without clashing with the installed system
dependencies.

.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html
.. _authentication document: https://github.com/GoogleCloudPlatform/google-cloud-common/tree/master/authentication
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/

Using the API
-------------

The Google Cloud `RuntimeConfig`_ (`RuntimeConfig API docs`_) API enables
developers to dynamically configure and expose variables through Google Cloud
Platform. In addition, you can also set Watchers and Waiters that will watch
for changes to your data and return based on certain conditions.
Mac/Linux
^^^^^^^^^

.. _RuntimeConfig: https://cloud.google.com/deployment-manager/runtime-configurator/
.. _RuntimeConfig API docs: https://cloud.google.com/deployment-manager/runtime-configurator/reference/rest/
.. code-block:: console

pip install virtualenv
virtualenv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install google-cloud-runtimeconfig


Windows
^^^^^^^

.. code-block:: console

pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install google-cloud-runtimeconfig

Next Steps
~~~~~~~~~~

- Read the `Client Library Documentation`_ for Google Cloud RuntimeConfig
API to see other available methods on the client.
- Read the `Product documentation`_ to learn
more about the product and see How-to Guides.

See the ``google-cloud-python`` API runtimeconfig `Documentation`_ to learn
how to interact with Cloud RuntimeConfig using this Client Library.

.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-runtimeconfig.svg
:target: https://pypi.org/project/google-cloud-runtimeconfig/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-runtimeconfig.svg
:target: https://pypi.org/project/google-cloud-runtimeconfig/
1 change: 1 addition & 0 deletions runtimeconfig/docs/changelog.md
File renamed without changes.
File renamed without changes.
22 changes: 22 additions & 0 deletions runtimeconfig/docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
.. include:: /../runtimeconfig/README.rst

API Reference
=============

.. toctree::
:maxdepth: 2

client
config
variable

Changelog
---------

For a list of all ``google-cloud-runtimeconfig`` releases:

.. toctree::
:maxdepth: 2

changelog

8 changes: 8 additions & 0 deletions runtimeconfig/docs/usage.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<html>
<head>
<meta http-equiv="refresh" content="1; url=./index.html:" />
<script>
window.location.href = "./index.html"
</script>
</head>
</html>
File renamed without changes.