Skip to content

Commit 23aeafc

Browse files
authored
docs: update api description (#11125)
* docs: update api description * run post processor
1 parent 7c1217d commit 23aeafc

File tree

4 files changed

+15
-15
lines changed

4 files changed

+15
-15
lines changed

packages/google-cloud-ids/.repo-metadata.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@
1313
"default_version": "v1",
1414
"codeowner_team": "",
1515
"api_shortname": "ids",
16-
"api_description": " monitors your networks, and it alerts you when it detects malicious activity. Cloud IDS is powered by Palo Alto Networks."
16+
"api_description": "Cloud IDS is an intrusion detection service that provides threat detection for intrusions, malware, spyware, and command-and-control attacks on your network. Cloud IDS works by creating a Google-managed peered network with mirrored VMs. Traffic in the peered network is mirrored, and then inspected by Palo Alto Networks threat protection technologies to provide advanced threat detection."
1717
}

packages/google-cloud-ids/CONTRIBUTING.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -35,21 +35,21 @@ Using a Development Checkout
3535
You'll have to create a development environment using a Git checkout:
3636

3737
- While logged into your GitHub account, navigate to the
38-
``python-ids`` `repo`_ on GitHub.
38+
``google-cloud-python`` `repo`_ on GitHub.
3939

40-
- Fork and clone the ``python-ids`` repository to your GitHub account by
40+
- Fork and clone the ``google-cloud-python`` repository to your GitHub account by
4141
clicking the "Fork" button.
4242

43-
- Clone your fork of ``python-ids`` from your GitHub account to your local
43+
- Clone your fork of ``google-cloud-python`` from your GitHub account to your local
4444
computer, substituting your account username and specifying the destination
45-
as ``hack-on-python-ids``. E.g.::
45+
as ``hack-on-google-cloud-python``. E.g.::
4646

4747
$ cd ${HOME}
48-
$ git clone git@github.com:USERNAME/python-ids.git hack-on-python-ids
49-
$ cd hack-on-python-ids
50-
# Configure remotes such that you can pull changes from the googleapis/python-ids
48+
$ git clone git@github.com:USERNAME/google-cloud-python.git hack-on-google-cloud-python
49+
$ cd hack-on-google-cloud-python
50+
# Configure remotes such that you can pull changes from the googleapis/google-cloud-python
5151
# repository into your local repository.
52-
$ git remote add upstream git@github.com:googleapis/python-ids.git
52+
$ git remote add upstream git@github.com:googleapis/google-cloud-python.git
5353
# fetch and merge changes from upstream into main
5454
$ git fetch upstream
5555
$ git merge upstream/main
@@ -60,7 +60,7 @@ repo, from which you can submit a pull request.
6060
To work on the codebase and run the tests, we recommend using ``nox``,
6161
but you can also use a ``virtualenv`` of your own creation.
6262

63-
.. _repo: https://github.com/googleapis/python-ids
63+
.. _repo: https://github.com/googleapis/google-cloud-python
6464

6565
Using ``nox``
6666
=============
@@ -113,7 +113,7 @@ Coding Style
113113
export GOOGLE_CLOUD_TESTING_BRANCH="main"
114114

115115
By doing this, you are specifying the location of the most up-to-date
116-
version of ``python-ids``. The
116+
version of ``google-cloud-python``. The
117117
remote name ``upstream`` should point to the official ``googleapis``
118118
checkout and the branch should be the default branch on that remote (``main``).
119119

@@ -209,7 +209,7 @@ The `description on PyPI`_ for the project comes directly from the
209209
``README``. Due to the reStructuredText (``rst``) parser used by
210210
PyPI, relative links which will work on GitHub (e.g. ``CONTRIBUTING.rst``
211211
instead of
212-
``https://github.com/googleapis/python-ids/blob/main/CONTRIBUTING.rst``)
212+
``https://github.com/googleapis/google-cloud-python/blob/main/CONTRIBUTING.rst``)
213213
may cause problems creating links or rendering the description.
214214

215215
.. _description on PyPI: https://pypi.org/project/google-cloud-ids
@@ -236,7 +236,7 @@ We support:
236236

237237
Supported versions can be found in our ``noxfile.py`` `config`_.
238238

239-
.. _config: https://github.com/googleapis/python-ids/blob/main/noxfile.py
239+
.. _config: https://github.com/googleapis/google-cloud-python/blob/main/noxfile.py
240240

241241

242242
We also explicitly decided to support Python 3 beginning with version 3.7.

packages/google-cloud-ids/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Python Client for Cloud IDS
33

44
|stable| |pypi| |versions|
55

6-
`Cloud IDS`_: monitors your networks, and it alerts you when it detects malicious activity. Cloud IDS is powered by Palo Alto Networks.
6+
`Cloud IDS`_: Cloud IDS is an intrusion detection service that provides threat detection for intrusions, malware, spyware, and command-and-control attacks on your network. Cloud IDS works by creating a Google-managed peered network with mirrored VMs. Traffic in the peered network is mirrored, and then inspected by Palo Alto Networks threat protection technologies to provide advanced threat detection.
77

88
- `Client Library Documentation`_
99
- `Product Documentation`_

packages/google-cloud-ids/docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@
156156
html_theme_options = {
157157
"description": "Google Cloud Client Libraries for google-cloud-ids",
158158
"github_user": "googleapis",
159-
"github_repo": "python-ids",
159+
"github_repo": "google-cloud-python",
160160
"github_banner": True,
161161
"font_family": "'Roboto', Georgia, sans",
162162
"head_font_family": "'Roboto', Georgia, serif",

0 commit comments

Comments
 (0)