Skip to content

Commit 9145055

Browse files
docs: 📝 expanded note for examples link with git clone command
1 parent 4c35b6a commit 9145055

5 files changed

Lines changed: 41 additions & 2 deletions

File tree

docs/source/examples/auth_example.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,19 @@ methods when connecting to an Aruba Orchestrator instance with pyedgeconnect.
1010
The example scripts provided in the repository use this process in
1111
addition to any other required logic for a particular use-case.
1212

13+
.. note::
14+
15+
The code referenced in this document and all published examples
16+
with pyedgeconnect are available from the GitHub repository within the
17+
`examples <https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
18+
folder. Each example script contains logic to authenticate to the
19+
Orchestrator as documented in the authentication example.
20+
21+
Clone the repository and download the examples with:
22+
23+
.. code:: bash
24+
25+
$ git clone https://github.com/SPOpenSource/edgeconnect-python.git
1326
1427
1528
Environment variables

docs/source/examples/basic_examples.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@
99
folder. Each example script contains logic to authenticate to the
1010
Orchestrator as documented in the authentication example.
1111

12+
Clone the repository and download the examples with:
13+
14+
.. code:: bash
15+
16+
$ git clone https://github.com/SPOpenSource/edgeconnect-python.git
17+
1218
1319
Print Appliance Information
1420
===========================

docs/source/examples/generate_preconfig.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,14 @@
1414
The code referenced in this document and all published examples
1515
with pyedgeconnect are available from the GitHub repository within the
1616
`examples <https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
17-
folder
17+
folder. Each example script contains logic to authenticate to the
18+
Orchestrator as documented in the authentication example.
19+
20+
Clone the repository and download the examples with:
21+
22+
.. code:: bash
23+
24+
$ git clone https://github.com/SPOpenSource/edgeconnect-python.git
1825
1926
Generate EdgeConnect Preconfig
2027
------------------------------

docs/source/examples/index.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@ GitHub repository within the
77
`examples <https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
88
folder:
99

10+
Clone the repository and download the examples with:
11+
12+
.. code:: bash
13+
14+
$ git clone https://github.com/SPOpenSource/edgeconnect-python.git
15+
1016
1117
Example script documentation and instructions
1218

docs/source/examples/upload_security_policy.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,14 @@
2020
The code referenced in this document and all published examples
2121
with pyedgeconnect are available from the GitHub repository within the
2222
`examples <https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
23-
folder:
23+
folder. Each example script contains logic to authenticate to the
24+
Orchestrator as documented in the authentication example.
25+
26+
Clone the repository and download the examples with:
27+
28+
.. code:: bash
29+
30+
$ git clone https://github.com/SPOpenSource/edgeconnect-python.git
2431
2532
Upload EdgeConnect Security Policy
2633
----------------------------------

0 commit comments

Comments
 (0)