Skip to content

Commit 353135a

Browse files
tseavertseaver
authored
runtimeconfig: prep docs for repo split. (#6023)
- Move contents of 'docs/runtimeconfig/' to 'runtimeconfig/docs'. - Rename 'runtimeconfig/docs/usage.rst' to 'runtimeconfig/docs/index.rst', and add a static redirect page, 'runtimeconfig/docs/usage.html'. - Harmonize / DRY 'runtimeconfig/README.rst' / 'runtimeconfig/docs/index.rst'. Toward #5912
1 parent 2198ab4 commit 353135a

File tree

7 files changed

+107
-34
lines changed

7 files changed

+107
-34
lines changed

‎packages/google-cloud-runtimeconfig/README.rst‎

Lines changed: 58 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,83 @@
11
Python Client for Google Cloud RuntimeConfig
22
============================================
33

4-
Python idiomatic client for `Google Cloud RuntimeConfig`_
5-
6-
.. _Google Cloud RuntimeConfig: https://cloud.google.com/deployment-manager/runtime-configurator/
7-
84
|alpha| |pypi| |versions|
95

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

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

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

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

1825
Quick Start
1926
-----------
2027

21-
::
28+
In order to use this library, you first need to go through the following steps:
2229

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

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

29-
.. _Python Development Environment Setup Guide: https://cloud.google.com/python/setup
40+
Installation
41+
~~~~~~~~~~~~
3042

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

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

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

42-
Using the API
43-
-------------
4453

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

50-
.. _RuntimeConfig: https://cloud.google.com/deployment-manager/runtime-configurator/
51-
.. _RuntimeConfig API docs: https://cloud.google.com/deployment-manager/runtime-configurator/reference/rest/
57+
.. code-block:: console
58+
59+
pip install virtualenv
60+
virtualenv <your-env>
61+
source <your-env>/bin/activate
62+
<your-env>/bin/pip install google-cloud-runtimeconfig
63+
64+
65+
Windows
66+
^^^^^^^
67+
68+
.. code-block:: console
69+
70+
pip install virtualenv
71+
virtualenv <your-env>
72+
<your-env>\Scripts\activate
73+
<your-env>\Scripts\pip.exe install google-cloud-runtimeconfig
74+
75+
Next Steps
76+
~~~~~~~~~~
77+
78+
- Read the `Client Library Documentation`_ for Google Cloud RuntimeConfig
79+
API to see other available methods on the client.
80+
- Read the `Product documentation`_ to learn
81+
more about the product and see How-to Guides.
5282

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

56-
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-runtimeconfig.svg
57-
:target: https://pypi.org/project/google-cloud-runtimeconfig/
58-
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-runtimeconfig.svg
59-
:target: https://pypi.org/project/google-cloud-runtimeconfig/

‎packages/google-cloud-runtimeconfig/docs/changelog.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../CHANGELOG.md

‎packages/google-cloud-runtimeconfig/docs/client.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Runtime Configuration Client
2+
============================
3+
4+
.. automodule:: google.cloud.runtimeconfig.client
5+
:members:
6+
:show-inheritance:

‎packages/google-cloud-runtimeconfig/docs/config.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Configuration
2+
~~~~~~~~~~~~~
3+
4+
.. automodule:: google.cloud.runtimeconfig.config
5+
:members:
6+
:show-inheritance:

‎packages/google-cloud-runtimeconfig/docs/index.rst‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.. include:: /../runtimeconfig/README.rst
2+
3+
API Reference
4+
=============
5+
6+
.. toctree::
7+
:maxdepth: 2
8+
9+
client
10+
config
11+
variable
12+
13+
Changelog
14+
---------
15+
16+
For a list of all ``google-cloud-runtimeconfig`` releases:
17+
18+
.. toctree::
19+
:maxdepth: 2
20+
21+
changelog
22+

‎packages/google-cloud-runtimeconfig/docs/usage.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<html>
2+
<head>
3+
<meta http-equiv="refresh" content="1; url=./index.html:" />
4+
<script>
5+
window.location.href = "./index.html"
6+
</script>
7+
</head>
8+
</html>

‎packages/google-cloud-runtimeconfig/docs/variable.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Variables
2+
~~~~~~~~~
3+
4+
.. automodule:: google.cloud.runtimeconfig.variable
5+
:members:
6+
:show-inheritance:

0 commit comments

Comments
 (0)