Skip to content

Commit e0fe9a2

Browse files
tseavertseaver
authored
Container: harmonize / DRY 'README.rst' / 'docs/index.rst'. (#6018)
Toward #5912.
1 parent 6e304b7 commit e0fe9a2

3 files changed

Lines changed: 23 additions & 89 deletions

File tree

‎container/README.rst‎

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
11
Python Client for Google Container Engine API (`Alpha`_)
22
========================================================
33

4+
|pypi| |versions|
5+
46
`Google Container Engine API`_: The Google Kubernetes Engine API is used for building and managing container
57
based applications, powered by the open source Kubernetes technology.
68

79
- `Client Library Documentation`_
810
- `Product Documentation`_
911

1012
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
13+
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-container.svg
14+
:target: https://pypi.org/project/google-cloud-container/
15+
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-container.svg
16+
:target: https://pypi.org/project/google-cloud-container/
1117
.. _Google Container Engine API: https://cloud.google.com/container
1218
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/container/index.html
1319
.. _Product Documentation: https://cloud.google.com/container
@@ -60,11 +66,8 @@ Windows
6066
<your-env>\Scripts\activate
6167
<your-env>\Scripts\pip.exe install google-cloud-container
6268
63-
Preview
64-
~~~~~~~
65-
66-
ClusterManagerClient
67-
^^^^^^^^^^^^^^^^^^^^
69+
Example Usage
70+
~~~~~~~~~~~~~
6871

6972
.. code:: py
7073
@@ -82,10 +85,5 @@ Next Steps
8285

8386
- Read the `Client Library Documentation`_ for Google Container Engine API
8487
API to see other available methods on the client.
85-
- Read the `Google Container Engine API Product documentation`_ to learn
86-
more about the product and see How-to Guides.
87-
- View this `repository’s main README`_ to see the full list of Cloud
88-
APIs that we cover.
89-
90-
.. _Google Container Engine API Product documentation: https://cloud.google.com/container
91-
.. _repository’s main README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
88+
- Read the `Product documentation`_ to learn more about the product and see
89+
How-to Guides.

‎container/docs/changelog.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
../../container/CHANGELOG.md
1+
../CHANGELOG.md

‎container/docs/index.rst‎

Lines changed: 12 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,19 @@
1-
Python Client for Google Container Engine API (`Beta`_)
2-
========================================================
1+
.. include:: /../container/README.rst
32

4-
`Google Container Engine API`_: The Google Kubernetes Engine API is used for building and managing container
5-
based applications, powered by the open source Kubernetes technology.
6-
7-
- `Client Library Documentation`_
8-
- `Product Documentation`_
9-
10-
.. _Beta: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
11-
.. _Google Container Engine API: https://cloud.google.com/container
12-
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/container/index.html
13-
.. _Product Documentation: https://cloud.google.com/container
14-
15-
Quick Start
16-
-----------
17-
18-
In order to use this library, you first need to go through the following steps:
19-
20-
1. `Select or create a Cloud Platform project.`_
21-
2. `Enable the Google Container Engine API.`_
22-
3. `Setup Authentication.`_
23-
24-
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
25-
.. _Enable the Google Container Engine API.: https://cloud.google.com/container
26-
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/latest/core/auth.html
27-
28-
Installation
29-
~~~~~~~~~~~~
30-
31-
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
32-
create isolated Python environments. The basic problem it addresses is one of
33-
dependencies and versions, and indirectly permissions.
34-
35-
With `virtualenv`_, it's possible to install this library without needing system
36-
install permissions, and without clashing with the installed system
37-
dependencies.
38-
39-
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
40-
41-
42-
Mac/Linux
43-
^^^^^^^^^
44-
45-
.. code-block:: console
46-
47-
pip install virtualenv
48-
virtualenv <your-env>
49-
source <your-env>/bin/activate
50-
<your-env>/bin/pip install google-cloud-container
51-
52-
53-
Windows
54-
^^^^^^^
55-
56-
.. code-block:: console
57-
58-
pip install virtualenv
59-
virtualenv <your-env>
60-
<your-env>\Scripts\activate
61-
<your-env>\Scripts\pip.exe install google-cloud-container
3+
API Reference
4+
-------------
5+
.. toctree::
6+
:maxdepth: 2
627

63-
Next Steps
64-
~~~~~~~~~~
8+
gapic/v1/api
9+
gapic/v1/types
6510

66-
- Read the `Client Library Documentation`_ for Google Container Engine API
67-
API to see other available methods on the client.
68-
- Read the `Google Container Engine API Product documentation`_ to learn
69-
more about the product and see How-to Guides.
70-
- View this `repository’s main README`_ to see the full list of Cloud
71-
APIs that we cover.
11+
Changelog
12+
---------
7213

73-
.. _Google Container Engine API Product documentation: https://cloud.google.com/container
74-
.. _repository’s main README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
14+
For a list of all ``google-cloud-container`` releases:
7515

76-
Api Reference
77-
-------------
7816
.. toctree::
79-
:maxdepth: 2
17+
:maxdepth: 2
8018

81-
gapic/v1/api
82-
gapic/v1/types
83-
changelog
19+
changelog

0 commit comments

Comments
 (0)