-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[EDU-5572] feat: new-sanity-guides (#1449)
* feat:new-sanity-guides * Update src/content/docs/en/pages/guides/marketplace/templates/clean-angular-sanity.mdx Co-authored-by: Mariana Bellorín Aguilera <[email protected]> * Update src/content/docs/en/pages/guides/marketplace/templates/clean-angular-sanity.mdx Co-authored-by: Mariana Bellorín Aguilera <[email protected]> * Update src/content/docs/en/pages/guides/marketplace/templates/clean-astro-sanity.mdx Co-authored-by: Mariana Bellorín Aguilera <[email protected]> * Update src/content/docs/en/pages/guides/marketplace/templates/clean-astro-sanity.mdx Co-authored-by: Mariana Bellorín Aguilera <[email protected]> * Update src/content/docs/en/pages/guides/marketplace/templates/clean-nuxt-sanity.mdx Co-authored-by: Mariana Bellorín Aguilera <[email protected]> * Update src/content/docs/en/pages/guides/marketplace/templates/clean-angular-sanity.mdx Co-authored-by: Mariana Bellorín Aguilera <[email protected]> * Update src/content/docs/en/pages/guides/marketplace/templates/clean-astro-sanity.mdx Co-authored-by: Mariana Bellorín Aguilera <[email protected]> * Update src/content/docs/en/pages/guides/marketplace/templates/clean-nuxt-sanity.mdx Co-authored-by: Mariana Bellorín Aguilera <[email protected]> * Update src/content/docs/en/pages/main-menu/additional-resources/templates-and-integrations/understand-azion-templates.mdx Co-authored-by: Mariana Bellorín Aguilera <[email protected]> * Update src/content/docs/en/pages/guides/marketplace/templates/clean-angular-sanity.mdx * Update src/content/docs/en/pages/guides/marketplace/templates/clean-angular-sanity.mdx * Update src/content/docs/en/pages/guides/marketplace/templates/clean-astro-sanity.mdx * Update src/content/docs/en/pages/guides/marketplace/templates/clean-astro-sanity.mdx * Apply suggestions from code review --------- Co-authored-by: Mariana Bellorín Aguilera <[email protected]>
- Loading branch information
1 parent
b960375
commit e885519
Showing
10 changed files
with
683 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
98 changes: 98 additions & 0 deletions
98
src/content/docs/en/pages/guides/marketplace/templates/clean-angular-sanity.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| --- | ||
| title: How to deploy a web application based on Clean Angular + Sanity application | ||
| description: The Clean Angular + Sanity application template integrates an Angular application with Sanity Studio for content management and team collaboration. | ||
| meta_tags: 'templates, guides, Azion Marketplace, Sanity, angular' | ||
| namespace: docs_guides_clean_angular_sanity | ||
| permalink: /documentation/products/guides/clean-angular-sanity/ | ||
| --- | ||
|
|
||
| import Tag from 'primevue/tag'; | ||
|
|
||
| <Tag severity="info" client:only="vue"> | ||
| Preview | ||
| </Tag> | ||
|
|
||
| The Azion **Clean Angular + Sanity application** template creates an [Angular](https://angular.dev/overview) application integrated with [Sanity Studio](http://sanity.io/), an open-source React-based content management interface. The Studio connects to your Sanity project's dataset and can be deployed for team collaboration after local configuration. | ||
|
|
||
| This template uses Angular version `16.0.1`. | ||
|
|
||
| --- | ||
|
|
||
| ## Requirements | ||
|
|
||
| - A [GitHub account](https://github.com/signup) to connect with Azion and create your new repository. | ||
| - Every push will be deployed automatically to this repository to keep your project updated. | ||
| - A [Sanity.io](http://sanity.io/) account. | ||
| - This template uses [Application Accelerator](/en/documentation/products/build/edge-application/application-accelerator/), [Edge Functions](/en/documentation/products/build/edge-application/edge-functions/), and [Edge Cache](https://www.azion.com/en/documentation/products/build/edge-application/edge-cache/), and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information. | ||
|
|
||
| --- | ||
|
|
||
| ## Deploying the template | ||
|
|
||
| You can obtain and configure your template through the Azion Console. To easily deploy it at the edge, click the button below. | ||
|
|
||
| <LinkButton | ||
| label="Deploy" | ||
| link="https://console.azion.com/create/sanity/clean-angular-sanity-app" | ||
| icon="ai ai-azion" | ||
| icon-pos="left" | ||
| /> | ||
|
|
||
| --- | ||
|
|
||
| ## Setting up the template | ||
|
|
||
| :::note[important] | ||
| To start a blog project with Sanity, you have two options: | ||
|
|
||
| - **Sanity CLI**: create your project for free by selecting the blog template. | ||
| - **Sanity GUI**: the use of this option may incur costs. For more information, visit the [Sanity CMS](http://sanity.io/) website. | ||
| ::: | ||
|
|
||
| In the configuration form, you must provide the information to configure your application. Fill in the presented fields. | ||
|
|
||
| Fields identified with an asterisk are mandatory. | ||
|
|
||
| 1. Connect Azion with your GitHub account. | ||
| - A pop-up window will open to confirm the installation of the [Azion GitHub App](https://www.azion.com/en/documentation/products/guides/azion-github-app/), a tool that connects your GitHub account with Azion's platform. | ||
| - Define your permissions and repository access as desired. | ||
| 2. Select the **Git Scope** to work with. | ||
| 3. Fill in the information to setup the application: | ||
| - **Application Name**: define a unique name for your edge application. | ||
| - **Sanity Project ID**: project ID from which the content will be read. | ||
| - **Sanity Studio Dataset**: dataset from which the content will be read. | ||
| 4. Click the **Deploy** button to start the deployment process. | ||
|
|
||
| During the deployment, you'll be able to follow the process through a window showing off the logs. When it's complete, the page shows information about the application and some options to continue your journey. | ||
|
|
||
| :::note | ||
| The link to the edge application allows you to see it on the browser. However, it takes a certain time to propagate and configure the application in Azion's edge locations. It may be necessary to wait a few minutes for the URL to be activated and for the application page to be effectively displayed in the browser. | ||
| ::: | ||
|
|
||
| --- | ||
|
|
||
| ## Managing the template | ||
|
|
||
| Considering that this initial setup may not be optimal for your specific edge application, all settings can be customized any time you need by using Azion's platform. | ||
|
|
||
| To manage and edit your edge application's settings, follow these steps: | ||
|
|
||
| 1. [Access Azion Console](https://console.azion.com). | ||
| 2. On the upper-left corner, select **Products menu**, the icon with three horizontal lines, > **Edge Application**. | ||
| - You'll be redirected to the **Edge Application** page. It lists all the edge applications you've created. | ||
| 3. Find the edge application related to your template and select it. | ||
| - The list is organized alphabetically. You can also use the **search bar** located in the upper-left corner of the list; currently, it filters only by **Application Name**. | ||
|
|
||
| After selecting the edge application you'll work on, you'll be directed to a page containing all the settings you can configure. | ||
|
|
||
| :::tip | ||
| Read the documentation about [managing edge applications](/en/documentation/products/build/edge-application/first-steps/) for more details. | ||
| ::: | ||
|
|
||
| ### Adding a custom domain | ||
|
|
||
| The edge application created during the deployment has an assigned Azion domain to make it accessible through the browser. The domain has the following format: `xxxxxxxxxx.map.azionedge.net/`. However, you can add a custom domain for users to access your edge application through it. | ||
|
|
||
| import LinkButton from 'azion-webkit/linkbutton'; | ||
|
|
||
| <LinkButton link="/en/documentation/products/guides/configure-a-domain/" label="Go to Configuring a Domain Guide" severity="secondary" /> |
98 changes: 98 additions & 0 deletions
98
src/content/docs/en/pages/guides/marketplace/templates/clean-astro-sanity.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| --- | ||
| title: How to deploy a web application based on Clean Astro + Sanity application | ||
| description: The Clean Astro + Sanity application template creates a minimal Astro website integrated with Sanity.io for content management. | ||
| meta_tags: 'templates, guides, Azion Marketplace, Sanity, astro' | ||
| namespace: docs_guides_clean_astro_sanity | ||
| permalink: /documentation/products/guides/clean-astro-sanity/ | ||
| --- | ||
|
|
||
| import Tag from 'primevue/tag'; | ||
|
|
||
| <Tag severity="info" client:only="vue"> | ||
| Preview | ||
| </Tag> | ||
|
|
||
| The Azion **Clean Astro + Sanity application** template creates a minimal [Astro](https://docs.astro.build/en/concepts/why-astro/) website integrated with [Sanity](http://sanity.io/) for content management. | ||
|
|
||
| This template uses Astro version `3.1.4`. | ||
|
|
||
| --- | ||
|
|
||
| ## Requirements | ||
|
|
||
| - A [GitHub account](https://github.com/signup) to connect with Azion and create your new repository. | ||
| - Every push will be deployed automatically to this repository to keep your project updated. | ||
| - A [Sanity.io](http://sanity.io/) account. | ||
| - This template uses [Application Accelerator](/en/documentation/products/build/edge-application/application-accelerator/), [Edge Functions](/en/documentation/products/build/edge-application/edge-functions/), and [Edge Cache](https://www.azion.com/en/documentation/products/build/edge-application/edge-cache/), and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information. | ||
|
|
||
| --- | ||
|
|
||
| ## Deploying the template | ||
|
|
||
| You can obtain and configure your template through the Azion Console. To easily deploy it at the edge, click the button below. | ||
|
|
||
| <LinkButton | ||
| label="Deploy" | ||
| link="https://console.azion.com/create/sanity/clean-astro-sanity-app" | ||
| icon="ai ai-azion" | ||
| icon-pos="left" | ||
| /> | ||
|
|
||
| --- | ||
|
|
||
| ## Setting up the template | ||
|
|
||
| :::note[important] | ||
| To start a blog project with Sanity, you have two options: | ||
|
|
||
| - **Sanity CLI**: create your project for free by selecting the blog template. | ||
| - **Sanity GUI**: the use of this option may incur costs. For more information, visit the [Sanity CMS](http://sanity.io/) website. | ||
| ::: | ||
|
|
||
| In the configuration form, you must provide the information to configure your application. Fill in the presented fields. | ||
|
|
||
| Fields identified with an asterisk are mandatory. | ||
|
|
||
| 1. Connect Azion with your GitHub account. | ||
| - A pop-up window will open to confirm the installation of the [Azion GitHub App](https://www.azion.com/en/documentation/products/guides/azion-github-app/), a tool that connects your GitHub account with Azion's platform. | ||
| - Define your permissions and repository access as desired. | ||
| 2. Select the **Git Scope** to work with. | ||
| 3. Fill in the information to setup the application: | ||
| - **Application Name**: define a unique name for your edge application. | ||
| - **Sanity Project ID**: project ID from which the content will be read. | ||
| - **Sanity Studio Dataset**: dataset from which the content will be read. | ||
| 4. Click the **Deploy** button to start the deployment process. | ||
|
|
||
| During the deployment, you'll be able to follow the process through a window showing off the logs. When it's complete, the page shows information about the application and some options to continue your journey. | ||
|
|
||
| :::note | ||
| The link to the edge application allows you to see it on the browser. However, it takes a certain time to propagate and configure the application in Azion's edge locations. It may be necessary to wait a few minutes for the URL to be activated and for the application page to be effectively displayed in the browser. | ||
| ::: | ||
|
|
||
| --- | ||
|
|
||
| ## Managing the template | ||
|
|
||
| Considering that this initial setup may not be optimal for your specific edge application, all settings can be customized any time you need by using Azion's platform. | ||
|
|
||
| To manage and edit your edge application's settings, follow these steps: | ||
|
|
||
| 1. [Access Azion Console](https://console.azion.com). | ||
| 2. On the upper-left corner, select **Products menu**, the icon with three horizontal lines, > **Edge Application**. | ||
| - You'll be redirected to the **Edge Application** page. It lists all the edge applications you've created. | ||
| 3. Find the edge application related to your template and select it. | ||
| - The list is organized alphabetically. You can also use the **search bar** located in the upper-left corner of the list; currently, it filters only by **Application Name**. | ||
|
|
||
| After selecting the edge application you'll work on, you'll be directed to a page containing all the settings you can configure. | ||
|
|
||
| :::tip | ||
| Read the documentation about [managing edge applications](/en/documentation/products/build/edge-application/first-steps/) for more details. | ||
| ::: | ||
|
|
||
| ### Adding a custom domain | ||
|
|
||
| The edge application created during the deployment has an assigned Azion domain to make it accessible through the browser. The domain has the following format: `xxxxxxxxxx.map.azionedge.net/`. However, you can add a custom domain for users to access your edge application through it. | ||
|
|
||
| import LinkButton from 'azion-webkit/linkbutton'; | ||
|
|
||
| <LinkButton link="/en/documentation/products/guides/configure-a-domain/" label="Go to Configuring a Domain Guide" severity="secondary" /> |
100 changes: 100 additions & 0 deletions
100
src/content/docs/en/pages/guides/marketplace/templates/clean-nuxt-sanity.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| --- | ||
| title: How to deploy a web application based on Clean Nuxt + Sanity application | ||
| description: A template that sets up a basic Nuxt application integrated with Sanity Studio—a React-based tool that connects to your Sanity dataset and can be deployed for team collaboration. | ||
| meta_tags: 'templates, guides, Azion Marketplace, Sanity, nuxt' | ||
| namespace: docs_guides_clean_nuxt_sanity | ||
| permalink: /documentation/products/guides/clean-nuxt-sanity/ | ||
| --- | ||
|
|
||
| import Tag from 'primevue/tag'; | ||
|
|
||
| <Tag severity="info" client:only="vue"> | ||
| Preview | ||
| </Tag> | ||
|
|
||
| The Azion **Clean Nuxt + Sanity application** template creates a minimal [Nuxt](https://nuxt.com/docs/getting-started/introduction) application with a [Sanity](http://sanity.io/) Studio, which is an open-source React application that connects to your Sanity project’s hosted dataset. The Studio is configured locally and can then be deployed for content collaboration. | ||
|
|
||
| This template uses Nuxt version `3.12.3`. | ||
|
|
||
| --- | ||
|
|
||
| ## Requirements | ||
|
|
||
| - A [GitHub account](https://github.com/signup) to connect with Azion and create your new repository. | ||
| - Every push will be deployed automatically to this repository to keep your project updated. | ||
| - A [Sanity.io](http://sanity.io/) account. | ||
| - This template uses [Application Accelerator](/en/documentation/products/build/edge-application/application-accelerator/), [Edge Functions](/en/documentation/products/build/edge-application/edge-functions/), and [Edge Cache](https://www.azion.com/en/documentation/products/build/edge-application/edge-cache/), and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information. | ||
|
|
||
| --- | ||
|
|
||
| ## Deploying the template | ||
|
|
||
| You can obtain and configure your template through the Azion Console. To easily deploy it at the edge, click the button below. | ||
|
|
||
| <LinkButton | ||
| label="Deploy" | ||
| link="https://console.azion.com/create/sanity/clean-nuxt-sanity-app" | ||
| icon="ai ai-azion" | ||
| icon-pos="left" | ||
| /> | ||
|
|
||
| --- | ||
|
|
||
| ## Setting up the template | ||
|
|
||
| :::note[important] | ||
|
|
||
| To start a blog project with Sanity, you have two options: | ||
|
|
||
| - **Sanity CLI**: create your project for free by selecting the blog template. | ||
| - **Sanity GUI**: the use of this option may incur costs. For more information, visit the [Sanity CMS](http://sanity.io/) website. | ||
| ::: | ||
|
|
||
| In the configuration form, you must provide the information to configure your application. Fill in the presented fields. | ||
|
|
||
| Fields identified with an asterisk are mandatory. | ||
|
|
||
| 1. Connect Azion with your GitHub account. | ||
| - A pop-up window will open to confirm the installation of the [Azion GitHub App](https://www.azion.com/en/documentation/products/guides/azion-github-app/), a tool that connects your GitHub account with Azion's platform. | ||
| - Define your permissions and repository access as desired. | ||
| 2. Select the **Git Scope** to work with. | ||
| 3. Fill in the information to setup the application: | ||
| - **Application Name**: define a unique name for your edge application. | ||
| - **Sanity Project ID**: project ID from which the content will be read. | ||
| - **Sanity Studio Dataset**: dataset from which the content will be read. | ||
| - **Sanity API Read Token**: a security credential that provides access to read content from your Sanity dataset. | ||
| 4. Click the **Deploy** button to start the deployment process. | ||
|
|
||
| During the deployment, you'll be able to follow the process through a window showing off the logs. When it's complete, the page shows information about the application and some options to continue your journey. | ||
|
|
||
| :::note | ||
| The link to the edge application allows you to see it on the browser. However, it takes a certain time to propagate and configure the application in Azion's edge locations. It may be necessary to wait a few minutes for the URL to be activated and for the application page to be effectively displayed in the browser. | ||
| ::: | ||
|
|
||
| --- | ||
|
|
||
| ## Managing the template | ||
|
|
||
| Considering that this initial setup may not be optimal for your specific edge application, all settings can be customized any time you need by using Azion's platform. | ||
|
|
||
| To manage and edit your edge application's settings, follow these steps: | ||
|
|
||
| 1. [Access Azion Console](https://console.azion.com). | ||
| 2. On the upper-left corner, select **Products menu**, the icon with three horizontal lines, > **Edge Application**. | ||
| - You'll be redirected to the **Edge Application** page. It lists all the edge applications you've created. | ||
| 3. Find the edge application related to your template and select it. | ||
| - The list is organized alphabetically. You can also use the **search bar** located in the upper-left corner of the list; currently, it filters only by **Application Name**. | ||
|
|
||
| After selecting the edge application you'll work on, you'll be directed to a page containing all the settings you can configure. | ||
|
|
||
| :::tip | ||
| Read the documentation about [managing edge applications](/en/documentation/products/build/edge-application/first-steps/) for more details. | ||
| ::: | ||
|
|
||
| ### Adding a custom domain | ||
|
|
||
| The edge application created during the deployment has an assigned Azion domain to make it accessible through the browser. The domain has the following format: `xxxxxxxxxx.map.azionedge.net/`. However, you can add a custom domain for users to access your edge application through it. | ||
|
|
||
| import LinkButton from 'azion-webkit/linkbutton'; | ||
|
|
||
| <LinkButton link="/en/documentation/products/guides/configure-a-domain/" label="Go to Configuring a Domain Guide" severity="secondary" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.