Skip to content
This repository was archived by the owner on Dec 10, 2023. It is now read-only.

Commit dc56806

Browse files
authored
docs(samples): fix README to accurately reflect the new repo after the move (#72)
Fix README to accurately reflect the new repo after the move. - [X] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/python-dlp/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [ ] *N/A* ~Ensure the tests and linter pass~ - [ ] *N/A* ~Code coverage does not decrease (if any source code was changed)~ - [X] Appropriate docs were updated (if necessary) Fixes google internal bug b/173536792
1 parent a7b884e commit dc56806

File tree

3 files changed

+19
-17
lines changed

3 files changed

+19
-17
lines changed

samples/snippets/README.rst

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Google Data Loss Prevention Python Samples
55
===============================================================================
66

77
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
8-
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=dlp/README.rst
8+
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/python-dlp&page=editor&open_in_editor=samples/snippets/README.rst
99

1010

1111
This directory contains samples for Google Data Loss Prevention. `Google Data Loss Prevention`_ provides programmatic access to a powerful detection engine for personally identifiable information and other privacy-sensitive data in unstructured data streams.
@@ -37,11 +37,12 @@ credentials for applications.
3737
Install Dependencies
3838
++++++++++++++++++++
3939

40-
#. Clone python-docs-samples and change directory to the sample directory you want to use.
40+
#. Clone python-dlp and change directory to the sample directory you want to use.
4141

4242
.. code-block:: bash
4343
44-
$ git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
44+
$ git clone https://github.com/googleapis/python-dlp.git
45+
$ cd samples/snippets
4546
4647
#. Install `pip`_ and `virtualenv`_ if you do not already have them. You may want to refer to the `Python Development Environment Setup Guide`_ for Google Cloud Platform for instructions.
4748

@@ -77,7 +78,7 @@ Quickstart
7778
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
7879

7980
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
80-
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=dlp/quickstart.py,dlp/README.rst
81+
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/python-dlp&page=editor&open_in_editor=samples/snippets/quickstart.py,samples/snippets/README.rst
8182

8283

8384

@@ -95,7 +96,7 @@ Inspect Content
9596
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
9697

9798
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
98-
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=dlp/inspect_content.py,dlp/README.rst
99+
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/python-dlp&page=editor&open_in_editor=samples/snippets/inspect_content.py,samples/snippets/README.rst
99100

100101

101102

@@ -133,7 +134,7 @@ Redact Content
133134
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
134135

135136
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
136-
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=dlp/redact.py,dlp/README.rst
137+
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/python-dlp&page=editor&open_in_editor=samples/snippets/redact.py,samples/snippets/README.rst
137138

138139

139140

@@ -169,7 +170,7 @@ Metadata
169170
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
170171
171172
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
172-
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=dlp/metadata.py,dlp/README.rst
173+
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/python-dlp&page=editor&open_in_editor=samples/snippets/metadata.py,samples/snippets/README.rst
173174
174175
175176
@@ -202,7 +203,7 @@ Jobs
202203
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
203204
204205
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
205-
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=dlp/jobs.py,dlp/README.rst
206+
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/python-dlp&page=editor&open_in_editor=samples/snippets/jobs.py,samples/snippets/README.rst
206207
207208
208209
@@ -235,7 +236,7 @@ Templates
235236
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
236237
237238
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
238-
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=dlp/templates.py,dlp/README.rst
239+
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/python-dlp&page=editor&open_in_editor=samples/snippets/templates.py,samples/snippets/README.rst
239240
240241
241242
@@ -268,7 +269,7 @@ Triggers
268269
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
269270
270271
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
271-
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=dlp/triggers.py,dlp/README.rst
272+
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/python-dlp&page=editor&open_in_editor=samples/snippets/triggers.py,samples/snippets/README.rst
272273
273274
274275
@@ -301,7 +302,7 @@ Risk Analysis
301302
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
302303
303304
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
304-
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=dlp/risk.py,dlp/README.rst
305+
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/python-dlp&page=editor&open_in_editor=samples/snippets/risk.py,samples/snippets/README.rst
305306
306307
307308
@@ -340,7 +341,7 @@ DeID
340341
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
341342
342343
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
343-
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=dlp/deid.py,dlp/README.rst
344+
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/python-dlp&page=editor&open_in_editor=samples/snippets/deid.py,samples/snippets/README.rst
344345
345346
346347

scripts/readme-gen/templates/README.tmpl.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
===============================================================================
77

88
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
9-
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor={{folder}}/README.rst
9+
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/python-dlp&page=editor&open_in_editor={{folder}}/README.rst
1010

1111

1212
This directory contains samples for {{product.name}}. {{product.description}}
@@ -46,7 +46,7 @@ Samples
4646

4747
{% if not sample.hide_cloudshell_button %}
4848
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
49-
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor={{folder}}/{{sample.file}},{{folder}}/README.rst
49+
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/python-dlp&page=editor&open_in_editor={{folder}}/{{sample.file}},{{folder}}/README.rst
5050
{% endif %}
5151

5252

@@ -84,4 +84,4 @@ to `browse the source`_ and `report issues`_.
8484

8585
{% endif %}
8686

87-
.. _Google Cloud SDK: https://cloud.google.com/sdk/
87+
.. _Google Cloud SDK: https://cloud.google.com/sdk/

scripts/readme-gen/templates/install_deps.tmpl.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
Install Dependencies
22
++++++++++++++++++++
33

4-
#. Clone python-docs-samples and change directory to the sample directory you want to use.
4+
#. Clone python-dlp and change directory to the sample directory you want to use.
55

66
.. code-block:: bash
77
8-
$ git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
8+
$ git clone https://github.com/googleapis/python-dlp.git
9+
$ cd samples/snippets
910
1011
#. Install `pip`_ and `virtualenv`_ if you do not already have them. You may want to refer to the `Python Development Environment Setup Guide`_ for Google Cloud Platform for instructions.
1112

0 commit comments

Comments
 (0)