Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Fix broken paths, meta for ahrefs #3409

Merged
merged 2 commits into from
Apr 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/data/toolpad/studio/concepts/queries.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Connecting to data

<p class="description">Be it a database table or an external API, Toolpad Studio offers mechanisms to bring server-side data to the page as well as make mutations to external data sources. </p>
<p class="description">Be it a database table or an external API, Toolpad Studio offers mechanisms to read to – and write from – server-side data.</p>

:::info
Toolpad Studio uses `react-query` internally to run queries and actions. Look into [its documentation](https://tanstack.com/query/latest/docs/framework/react/guides/queries) for more details on query objects.
Expand Down
16 changes: 8 additions & 8 deletions docs/data/toolpad/studio/how-to-guides/render-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

1. With a GitHub account, you can create a new repository using the **+** button available in the header menu, followed by **New repository**. Then, select an appropriate name:

{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/studio/tutorials/deploy-render/render-github-new.png", "alt": "GitHub new repo ", "caption": "Creating a new GitHub repository", "indent": 1, "aspectRatio": 1 }}
{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/studio/how-to-guides/deploy-render/render-github-new.png", "alt": "GitHub new repo ", "caption": "Creating a new GitHub repository", "indent": 1, "aspectRatio": 1 }}

2. If the Toolpad Studio app is not currently a Git repository, you can run

Expand Down Expand Up @@ -41,19 +41,19 @@

1. With a Render account, you can create a new **Web Service**:

{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/studio/tutorials/deploy-render/render-start.png", "alt": "Render new web service ", "caption": "Creating a new Render Web Service", "indent": 1 }}
{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/studio/how-to-guides/deploy-render/render-start.png", "alt": "Render new web service ", "caption": "Creating a new Render Web Service", "indent": 1 }}

2. Depending on whether the visibility of the GitHub repository is set to private or public, you will need to either connect your GitHub account to Render, or paste in the URL of the repository you created above:

{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/studio/tutorials/deploy-render/render-connect-github.png", "alt": "GitHub new repo ", "caption": "Connecting GitHub to Render", "indent": 1, "aspectRatio": 2 }}
{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/studio/how-to-guides/deploy-render/render-connect-github.png", "alt": "GitHub new repo ", "caption": "Connecting GitHub to Render", "indent": 1, "aspectRatio": 2 }}

3. If using a private repository, you need to search for and select the repository you intend to deploy once connected to GitHub:

{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/studio/tutorials/deploy-render/render-search.png", "alt": "GitHub repo on Render ", "caption": "Connecting your GitHub repository", "indent": 1, "aspectRatio": 1.5}}
{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/studio/how-to-guides/deploy-render/render-search.png", "alt": "GitHub repo on Render ", "caption": "Connecting your GitHub repository", "indent": 1, "aspectRatio": 1.5}}

4. With the repository selected, you can advance to deployment configuration. Render can guess that you are deploying a Node app. Set the name which will appear in the URL of your deployed app, like `<APP-NAME>.onrender.com`:

{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/studio/tutorials/deploy-render/render-config-start.png", "alt": "Render deployment config ", "caption": "Setting the deployment configuration", "indent": 1 }}
{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/studio/how-to-guides/deploy-render/render-config-start.png", "alt": "Render deployment config ", "caption": "Setting the deployment configuration", "indent": 1 }}

5. The build and start commands will be set to

Expand All @@ -66,13 +66,13 @@

6. Select an appropriate instance type for your deployment.

{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/studio/tutorials/deploy-render/render-config-commands.png", "alt": "Render deployment commands and plan ", "caption": "Setting deployment commands and choosing an instance type", "indent": 1 }}
{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/studio/how-to-guides/deploy-render/render-config-commands.png", "alt": "Render deployment commands and plan ", "caption": "Setting deployment commands and choosing an instance type", "indent": 1 }}

7. Select **Create Web Service** to trigger the deployment. You will be redirected to the streaming logs of the in-progress deployment.

8. Render.com uses `14.7.0` as the default Node version. Toolpad Studio requires version `18.17.1` as the minimum Node version. You can change the default by setting a `NODE_VERSION` environment variable for your deployment:

{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/studio/tutorials/deploy-render/node-version.png", "alt": "Set NODE_VERSION ", "caption": "Overriding the default Node version", "indent": 1, "aspectRatio": 3 }}
{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/studio/how-to-guides/deploy-render/node-version.png", "alt": "Set NODE_VERSION ", "caption": "Overriding the default Node version", "indent": 1, "aspectRatio": 3 }}

<ul style="list-style-type: none">
<li>
Expand All @@ -86,7 +86,7 @@ See the [Render documentation](https://docs.render.com/node-version) on Node ver

8. Once this is successfully complete, you can access your Toolpad Studio app on `<APP-NAME>.onrender.com`.

{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/studio/tutorials/deploy-render/render-complete.png", "alt": "Render deployment complete ", "caption": "Deployed successfully", "indent": 1 }}
{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/studio/how-to-guides/deploy-render/render-complete.png", "alt": "Render deployment complete ", "caption": "Deployed successfully", "indent": 1 }}

That's it! We're up and running in a few minutes.

Expand Down
Loading