Skip to content

Commit 60c30df

Browse files
committed
Move instructions to contributing docs
1 parent 283379d commit 60c30df

File tree

2 files changed

+20
-19
lines changed

2 files changed

+20
-19
lines changed

admin/create_secrets_files.py

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,6 @@
11
"""Create licenses and target databases for the tests to run against.
22
3-
Usage:
4-
5-
$ export VWS_EMAIL_ADDRESS=...
6-
$ export VWS_PASSWORD=...
7-
$ export NEW_SECRETS_DIR=...
8-
$ export EXISTING_SECRETS_FILE=/existing/file/with/inactive/db/creds
9-
# You may have to run this a few times, but it is idempotent.
10-
$ python admin/create_secrets_files.py
11-
# After creating the secrets, update the encrypted archive:
12-
$ tar cvf secrets.tar "${NEW_SECRETS_DIR}"
13-
$ gpg \
14-
--yes \
15-
--batch \
16-
--passphrase="${PASSPHRASE_FOR_VUFORIA_SECRETS}" \
17-
--symmetric \
18-
--cipher-algo AES256 \
19-
secrets.tar
3+
See the instructions in the contributing guide in the documentation.
204
"""
215

226
import datetime

docs/source/contributing.rst

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,25 @@ To create an inactive project, delete the license key associated with a database
9191
Targets sometimes get stuck at the "Processing" stage meaning that they cannot be deleted.
9292
When this happens, create a new target database to use for testing.
9393

94-
To create databases without using the browser, use :file:`admin/create_secrets_files.py`.
95-
See instructions in that file.
94+
To create databases without using the browser, use :file:`admin/create_secrets_files.py`:
95+
96+
.. code-block:: bash
97+
98+
$ export VWS_EMAIL_ADDRESS=...
99+
$ export VWS_PASSWORD=...
100+
$ export NEW_SECRETS_DIR=...
101+
$ export EXISTING_SECRETS_FILE=/existing/file/with/inactive/db/creds
102+
# You may have to run this a few times, but it is idempotent.
103+
$ python admin/create_secrets_files.py
104+
# After creating the secrets, update the encrypted archive:
105+
$ tar cvf secrets.tar "${NEW_SECRETS_DIR}"
106+
$ gpg \
107+
--yes \
108+
--batch \
109+
--passphrase="${PASSPHRASE_FOR_VUFORIA_SECRETS}" \
110+
--symmetric \
111+
--cipher-algo AES256 \
112+
secrets.tar
96113
97114
.. _Vuforia License Manager: https://developer.vuforia.com/vui/develop/licenses
98115
.. _Vuforia Target Manager: https://developer.vuforia.com/vui/develop/databases

0 commit comments

Comments
 (0)