Skip to content

Commit ec5e02e

Browse files
tseavertseaver
authored
Error_reporting: prep docs for repo split. (googleapis#6155)
* Harmonize / DRY 'error_reporting/README.rst' / 'error_reporting/docs/index.rst'. Toward googleapis#5912. * Move 'docs/error-reporting/*' -> 'error_reporting/docs/'. Leave behind a symlink (note its name uses a hyphen rather than an underscore). Make the 'usage.rst' page only do usage docs -- the rest is in 'index.rst'.
1 parent 0ccd143 commit ec5e02e

10 files changed

Lines changed: 199 additions & 270 deletions

File tree

‎docs/error-reporting‎

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

‎docs/error-reporting/changelog.md‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/error-reporting/usage.rst‎

Lines changed: 0 additions & 142 deletions
This file was deleted.

‎docs/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
Translate <translate/index>
3232
Vision <vision/index>
3333
Video Intelligence <videointelligence/index>
34-
Stackdriver Error Reporting <error-reporting/usage>
34+
Stackdriver Error Reporting <error-reporting/index>
3535
Stackdriver Logging <logging/index>
3636
Stackdriver Monitoring <monitoring/index>
3737
Stackdriver Trace <trace/index>

‎error_reporting/README.rst‎

Lines changed: 61 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,82 @@
11
Python Client for Stackdriver Error Reporting
22
=============================================
33

4-
Python idiomatic client for `Stackdriver Error Reporting`_
5-
6-
.. _Stackdriver Error Reporting: https://cloud.google.com/error-reporting/
7-
84
|pypi| |versions|
95

10-
- `Documentation`_
6+
The Stackdriver `Error Reporting`_ API counts, analyzes and aggregates the
7+
crashes in your running cloud services. A centralized error management
8+
interface displays the results with sorting and filtering capabilities. A
9+
dedicated view shows the error details: time chart, occurrences, affected user
10+
count, first and last seen dates and a cleaned exception stack trace. Opt-in
11+
to receive email and mobile alerts on new errors.
12+
13+
- `Client Library Documentation`_
14+
- `Product Documentation`_
1115

12-
.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/error-reporting/usage.html
16+
.. _Error Reporting: https://cloud.google.com/error-reporting/
17+
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/error-reporting/usage.html
18+
.. _Product Documentation: https://cloud.google.com/error-reporting/reference/
19+
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-error-reporting.svg
20+
:target: https://pypi.org/project/google-cloud-error-reporting/
21+
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-error-reporting.svg
22+
:target: https://pypi.org/project/google-cloud-error-reporting/
1323

1424
Quick Start
1525
-----------
1626

17-
.. code-block:: console
27+
In order to use this library, you first need to go through the following steps:
1828

19-
$ pip install --upgrade google-cloud-error-reporting
29+
1. `Select or create a Cloud Platform project.`_
30+
2. `Enable billing for your project.`_
31+
3. `Enable the Google Cloud Datastore API.`_
32+
4. `Setup Authentication.`_
2033

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

25-
.. _Python Development Environment Setup Guide: https://cloud.google.com/python/setup
39+
Installation
40+
~~~~~~~~~~~~
2641

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

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

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

38-
Using the API
39-
-------------
4052

41-
The Stackdriver `Error Reporting`_ API (`Error Reporting API docs`_)
42-
counts, analyzes and aggregates the crashes in your running cloud services.
43-
A centralized error management interface displays the results with sorting
44-
and filtering capabilities. A dedicated view shows the error details: time
45-
chart, occurrences, affected user count, first and last seen dates and a
46-
cleaned exception stack trace. Opt-in to receive email and mobile alerts
47-
on new errors.
53+
Mac/Linux
54+
^^^^^^^^^
4855

49-
.. _Error Reporting: https://cloud.google.com/error-reporting/
50-
.. _Error Reporting API docs: https://cloud.google.com/error-reporting/reference/
56+
.. code-block:: console
5157
52-
See the ``google-cloud-python`` API Error Reporting `Documentation`_ to learn
53-
how to get started using this library.
58+
pip install virtualenv
59+
virtualenv <your-env>
60+
source <your-env>/bin/activate
61+
<your-env>/bin/pip install google-cloud-error-reporting
5462
55-
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-error-reporting.svg
56-
:target: https://pypi.org/project/google-cloud-error-reporting/
57-
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-error-reporting.svg
58-
:target: https://pypi.org/project/google-cloud-error-reporting/
63+
64+
Windows
65+
^^^^^^^
66+
67+
.. code-block:: console
68+
69+
pip install virtualenv
70+
virtualenv <your-env>
71+
<your-env>\Scripts\activate
72+
<your-env>\Scripts\pip.exe install google-cloud-error-reporting
73+
74+
75+
76+
Next Steps
77+
~~~~~~~~~~
78+
79+
- Read the `Client Library Documentation`_ for Google Cloud Datastore API
80+
API to see other available methods on the client.
81+
- Read the `Product documentation`_ to learn
82+
more about the product and see How-to Guides.

‎error_reporting/docs/changelog.md‎

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

docs/error-reporting/client.rst renamed to error_reporting/docs/client.rst

File renamed without changes.

0 commit comments

Comments
 (0)