Skip to content

Commit 4c35b6a

Browse files
docs: 🐛 Fix link typo back to GitHub repository for code examples
1 parent e0de501 commit 4c35b6a

5 files changed

Lines changed: 15 additions & 12 deletions

File tree

docs/source/examples/auth_example.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ related to authenticating to Orchestrator
2323
``ORCH_USER``
2424
``ORCH_PASSWORD``
2525

26-
If ORCH_URL is specified, it will take precedence, otherwise user will
27-
be prompted for input to enter the Orchestrator IP or FQDN
26+
If ``ORCH_URL`` is specified, it will take precedence, otherwise user
27+
will be prompted for input to enter the Orchestrator IP or FQDN
2828

29-
If ORCH_API_KEY is specified it will take precedence for an authentication
30-
method over user/password authentication. If not found, the user will be
31-
prompted for entering an API key.
29+
If ``ORCH_API_KEY`` is specified it will take precedence for an
30+
authentication method over user/password authentication. If not found,
31+
the user will be prompted for entering an API key.
3232

3333
.. code-block:: python
3434

docs/source/examples/basic_examples.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
.. basic_examples:
22
33
4-
The following examples are also included as individual .py files in the
5-
repository in the `examples` directory. Each example script contains
6-
logic to authenticate to the Orchestrator as documented in the
7-
authentication example.
4+
.. note::
5+
6+
The code referenced in this document and all published examples
7+
with pyedgeconnect are available from the GitHub repository within the
8+
`examples <https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
9+
folder. Each example script contains logic to authenticate to the
10+
Orchestrator as documented in the authentication example.
811

912

1013
Print Appliance Information

docs/source/examples/generate_preconfig.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
The code referenced in this document and all published examples
1515
with pyedgeconnect are available from the GitHub repository within the
16-
`examples <https://https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
16+
`examples <https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
1717
folder
1818

1919
Generate EdgeConnect Preconfig

docs/source/examples/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Example Code from Repository
44

55
All examples documented in this section are available from the
66
GitHub repository within the
7-
`examples <https://https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
7+
`examples <https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
88
folder:
99

1010

docs/source/examples/upload_security_policy.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
The code referenced in this document and all published examples
2121
with pyedgeconnect are available from the GitHub repository within the
22-
`examples <https://https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
22+
`examples <https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
2323
folder:
2424

2525
Upload EdgeConnect Security Policy

0 commit comments

Comments
 (0)