Skip to content

Commit e58d244

Browse files
Chore: Add note around data planes (#215)
## Description πŸ“ As titled.
1 parent 7ff9ed0 commit e58d244

File tree

15 files changed

+53
-26
lines changed

15 files changed

+53
-26
lines changed

β€Ždocs/_quickstart_template.mdxβ€Ž

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ acknowledge your login, giving you access to Hasura Cloud resources.
2020
### Step 2. Scaffold out a new local project
2121

2222
```ddn title="Next, create a new local project:"
23-
ddn supergraph init imdb-promptflix --with-promptql && cd imdb-promptflix
23+
# If you don't have a data plane provisioned, please contact your AI strategist
24+
ddn supergraph init imdb-promptflix --with-promptql --project-data-plane-id <your-data-plane-id> && cd imdb-promptflix
2425
```
2526

2627
Now that you're in this directory, you'll see your project scaffolded out for you. You can view the structure by either

β€Ždocs/how-to-build-with-promptql/_boilerplateInit.mdxβ€Ž

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ in, the CLI will acknowledge your login, giving you access to Hasura DDN resourc
1818
### Step 2. Scaffold out a new local project
1919

2020
```ddn title="Next, create a new local project:"
21-
ddn supergraph init my-project --with-promptql && cd my-project
21+
# If you don't have a data plane provisioned, please contact your AI strategist
22+
ddn supergraph init my-project --with-promptql --project-data-plane-id <your-data-plane-id> && cd my-project
2223
```
2324

2425
Once you move into this directory, you'll see your project scaffolded out for you. You can view the structure by either

β€Ždocs/metadata/guides/iterate.mdxβ€Ž

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,8 @@ You can also create a new build on Hasura Cloud:
102102
If you don't have a project on Hasura Cloud, you can create one by running:
103103

104104
```ddn
105-
ddn project init
105+
# If you don't have a data plane provisioned, please contact your AI strategist
106+
ddn project init --data-plane-id <your-data-plane-id>
106107
```
107108

108109
Then:

β€Ždocs/project-configuration/subgraphs/working-with-multiple-repositories.mdxβ€Ž

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,8 @@ overall API.
9191
This will serve as the parent project.
9292

9393
```ddn
94-
ddn supergraph init <parent-project> && cd <parent-project> && git init
94+
# If you don't have a data plane provisioned, please contact your AI strategist
95+
ddn supergraph init <parent-project> --project-data-plane-id <your-data-plane-id> && cd <parent-project> && git init
9596
```
9697

9798
This will scaffold the local configuration for your PromptQL project and initialize a Git repository.
@@ -101,7 +102,8 @@ This will scaffold the local configuration for your PromptQL project and initial
101102
This is based on the local parent project.
102103

103104
```ddn
104-
ddn project init
105+
# If you don't have a data plane provisioned, please contact your AI strategist
106+
ddn project init --data-plane-id <your-data-plane-id>
105107
```
106108

107109
In your configuration file (e.g., `.hasura/context.yaml`), you'll see a new `project` entry with the name of the project
@@ -164,7 +166,8 @@ The invited user will need to create a new supergraph on their machine with a ne
164166
They will use the same name for the subgraph as was created in the parent project.
165167

166168
```ddn
167-
ddn supergraph init <subgraph-name-as-supergraph-name> --create-subgraph <subgraph-name> && cd <subgraph-name> && git init
169+
# If you don't have a data plane provisioned, please contact your AI strategist
170+
ddn supergraph init <subgraph-name-as-supergraph-name> --create-subgraph <subgraph-name> --project-data-plane-id <your-data-plane-id> && cd <subgraph-name> && git init
168171
```
169172

170173
This scaffolds the necessary structure and initializes a Git repository.
@@ -174,7 +177,8 @@ This scaffolds the necessary structure and initializes a Git repository.
174177
This will initialize the cloud project as the parent project.
175178

176179
```ddn
177-
ddn project init --with-project <parent-project-name>
180+
# If you don't have a data plane provisioned, please contact your AI strategist
181+
ddn project init --with-project <parent-project-name> --data-plane-id <your-data-plane-id>
178182
```
179183

180184
Your configuration file will now link the local subgraph to the parent project.

β€Ždocs/project-configuration/tutorials/work-with-multiple-repositories.mdxβ€Ž

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,8 @@ provisioning subgraphs, inviting collaborators, and managing the API as a whole.
5858
### Step 1. Initialize a new local project
5959

6060
```ddn title="Create a new local project and initialize a git repository:"
61-
ddn supergraph init parent-project --with-promptql && cd parent-project && git init
61+
# If you don't have a data plane provisioned, please contact your AI strategist
62+
ddn supergraph init parent-project --with-promptql --project-data-plane-id <your-data-plane-id> && cd parent-project && git init
6263
```
6364

6465
This will scaffold out the local configuration for a PromptQL project and initialize a git repository.
@@ -113,7 +114,8 @@ initializing a new repository below.
113114
#### Step 1. Create a new repo for the `customers` subgraph
114115

115116
```ddn title="Initialize a new local project and git repo while also mapping to the existing cloud project:"
116-
ddn supergraph init customer-team --create-subgraph customers --with-project <project-name> --with-promptql && cd customer-team && git init
117+
# If you don't have a data plane provisioned, please contact your AI strategist
118+
ddn supergraph init customer-team --create-subgraph customers --with-project <project-name> --with-promptql --project-data-plane-id <your-data-plane-id> && cd customer-team && git init
117119
```
118120

119121
This will scaffold out the necessary project structure along with initializing a git repository for version control.
@@ -252,7 +254,8 @@ The steps below will allow you to incorporate your independent `billing` subgrap
252254
#### Step 1. Create a new repo for the `billing` subgraph
253255

254256
```ddn title="Initialize a new local project and git repo:"
255-
ddn supergraph init billing-team --with-project <project-name> --create-subgraph billing --with-promptql && cd billing-team && git init
257+
# If you don't have a data plane provisioned, please contact your AI strategist
258+
ddn supergraph init billing-team --with-project <project-name> --create-subgraph billing --with-promptql --project-data-plane-id <your-data-plane-id> && cd billing-team && git init
256259
```
257260

258261
This will scaffold out the necessary project structure along with initializing a git repository for version control.

β€Ždocs/promptql-playground/troubleshooting.mdxβ€Ž

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ ddn context get project
3030
If you get the error `Key "project" is not set.`, you need to initialize a DDN project.
3131

3232
```ddn title="Run the following command in the project directory:"
33-
ddn project init
33+
# If you don't have a data plane provisioned, please contact your AI strategist
34+
ddn project init --data-plane-id <your-data-plane-id>
3435
```
3536

3637
Restarting the local services post this should fix the issue.

β€Ždocs/recipes/tutorials/apple-health-assistant.mdxβ€Ž

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,8 @@ Now, let's set up the Hasura DDN project with PromptQL to start exploring the da
8787
```bash copy
8888
cd ddn-project
8989
ddn supergraph build local
90-
ddn project init
90+
# If you don't have a data plane provisioned, please contact your AI strategist
91+
ddn project init --data-plane-id <your-data-plane-id>
9192
```
9293

9394
- Add Anthropic API key to the`.env`.

β€Ždocs/recipes/tutorials/bart-api.mdxβ€Ž

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,8 @@ Now, let's set up the Hasura DDN project with PromptQL to start exploring the da
6969
In the root directory of the repo, run the following commands:
7070

7171
```ddn
72-
ddn project init
72+
# If you don't have a data plane provisioned, please contact your AI strategist
73+
ddn project init --data-plane-id <your-data-plane-id>
7374
```
7475

7576
Create a build:

β€Ždocs/recipes/tutorials/csv-files.mdxβ€Ž

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,8 @@ In the root directory of the repo, run the following commands:
6565

6666
```ddn
6767
ddn supergraph build local
68-
ddn project init
68+
# If you don't have a data plane provisioned, please contact your AI strategist
69+
ddn project init --data-plane-id <your-data-plane-id>
6970
```
7071

7172
- Start the DDN project

β€Ždocs/recipes/tutorials/duckduckgo-web-search.mdxβ€Ž

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,8 @@ In the root directory of the repo, run the following commands:
6464

6565
```ddn
6666
ddn supergraph build local
67-
ddn project init
67+
# If you don't have a data plane provisioned, please contact your AI strategist
68+
ddn project init --data-plane-id <your-data-plane-id>
6869
```
6970

7071
- Start the DDN project

0 commit comments

Comments
Β (0)