Skip to content

Commit 77705ad

Browse files
committed
Remove SDK folder: documentation is now managed in the SDK Python repo
1 parent 67b245b commit 77705ad

25 files changed

+27
-2559
lines changed

docs/docs/guides/check.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ Then save the `TagsQuery` as a text file named `tags_check.gql`.
110110

111111
### 2. Create the Python check file
112112

113-
The next step is to create the Check Python business logic. The check is a Python class that inherits from `InfrahubCheck` from the [Python SDK](../python-sdk). Create a file called `tags_check.py`:
113+
The next step is to create the Check Python business logic. The check is a Python class that inherits from `InfrahubCheck` from the [Python SDK]($(local_base_url_1)python-sdk). Create a file called `tags_check.py`:
114114

115115
```python
116116
import re

docs/docs/guides/generator.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ We provide `convert_query_response` option to be toggled to be able to access ob
104104

105105
This allows you to manage the returned data with helper methods on the SDK objects such as `save`, `fetch`, etc. on the returned data rather than having to build a payload to send back to Infrahub to manage the objects.
106106

107-
Read more on the [Infrahub Python SDK](../python-sdk).
107+
Read more on the [Infrahub Python SDK]($(local_base_url_1)python-sdk).
108108
:::
109109

110110
<Tabs groupId="convertResponse">
@@ -291,7 +291,7 @@ widget_generator (widget_generator.py::Generator) Target: widgets
291291

292292
:::warning
293293

294-
When running a generator with `infrahubctl` the [SDK tracking](../python-sdk/topics/tracking) feature isn't used. The reason for this is that internally Infrahub uses the ID of the generator_definition to control the tracking, this isn't available from the outside. For this reason it is recommended to create test branches when developing generators and validating the results.
294+
When running a generator with `infrahubctl` the [SDK tracking]($(local_base_url_1)python-sdk/topics/tracking) feature isn't used. The reason for this is that internally Infrahub uses the ID of the generator_definition to control the tracking, this isn't available from the outside. For this reason it is recommended to create test branches when developing generators and validating the results.
295295

296296
:::
297297

docs/docs/guides/python-transform.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ Here the query will require an input parameter called `$name` what will refer to
138138

139139
## 2. Create the Python transform file
140140

141-
The next step is to create the actual Python transform. The transform is a Python class that inherits from InfrahubTransform from the [Python SDK](../python-sdk). Create a file called `tags_transform.py`:
141+
The next step is to create the actual Python transform. The transform is a Python class that inherits from InfrahubTransform from the [Python SDK]($(local_base_url_1)python-sdk). Create a file called `tags_transform.py`:
142142

143143
```python
144144
from infrahub_sdk.transforms import InfrahubTransform

docs/docs/guides/repository.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ The repository should be visible under [Unified Storage / Repository](http://loc
155155

156156
### Via the Infrahub SDK
157157

158-
1. Install and setup the [Infrahub SDK](../python-sdk)
158+
1. Install and setup the [Infrahub SDK]($(local_base_url_1)python-sdk)
159159
2. If needed, i.e., your repository is private, create a Credential object to hold your username / password. We highly recommend to provide credentials for Repository to allow branch creation from Infrahub.
160160

161161
```python

docs/docs/infrahubctl.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ It's meant to run on any laptop or server and it communicates with a remote Infr
1818

1919
## Installation
2020

21-
The `infrahubctl` command line utility is installed as a part of the [Infrahub SDK for Python](./python-sdk/guides/installation#ctl).
21+
The `infrahubctl` command line utility is installed as a part of the [Infrahub SDK for Python]($(local_base_url_1)python-sdk/guides/installation#ctl).
2222

2323
## Configuration
2424

docs/docs/overview/data.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ When a schema has been loaded in to Infrahub, data can be populated or synced th
88

99
- Via the WebUI: users can add, modify, and delete objects
1010
- Via [infrahub-sync](https://docs.infrahub.app/sync)
11-
- Via the [Infrahub SDK](../python-sdk/), which simplifies working with the GraphQL API:
11+
- Via the [Infrahub SDK]($(local_base_url_1)python-sdk/), which simplifies working with the GraphQL API:
1212
- One-time imports can done similar to this [python example](https://github.com/opsmill/infrahub-demo-dc-fabric/blob/main/generators/create_basic.py)
1313
- Integration with other systems
1414
- Via the GraphQL or REST API directly

docs/docs/overview/interfaces.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Managing infrastructure at scale often means many people, teams, workflows and o
1616

1717
## GraphQL API
1818

19-
GraphQL is the primary API to interact with data, and allows access to everything defined by the schema. The [Python SDK](../python-sdk/) is built on top of the GraphQL API.
19+
GraphQL is the primary API to interact with data, and allows access to everything defined by the schema. The [Python SDK]($(local_base_url_1)python-sdk/) is built on top of the GraphQL API.
2020

2121
- By default, exposed on TCP port `8000` at the endpoint: `http://<API_SERVER_IP>:8000/graphql`
2222
- The Frontend utilizes the GraphQL API for most tasks
@@ -46,7 +46,7 @@ More information can be found in the [infrahubctl](../infrahubctl/) documentatio
4646

4747
The Infrahub Python SDK greatly simplifies how you can interact with Infrahub programmatically.
4848

49-
More information can be found in the [Python SDK](../python-sdk/) documentation section.
49+
More information can be found in the [Python SDK]($(local_base_url_1)python-sdk/) documentation section.
5050

5151
## Git
5252

docs/docs/python-sdk/guides/batch.mdx

Lines changed: 0 additions & 145 deletions
This file was deleted.

docs/docs/python-sdk/guides/branches.mdx

Lines changed: 0 additions & 132 deletions
This file was deleted.

0 commit comments

Comments
 (0)