From 24b818feee8e5918d87d976ff5d6d0c3dd6be294 Mon Sep 17 00:00:00 2001 From: Guilherme Afonso Oliveira Date: Thu, 3 Oct 2024 09:52:50 -0300 Subject: [PATCH] [EDU-5389] Eleventy E-commerce Templates guide (#1303) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat: add elenty ecommerce guide * feat: add entry in reference pages * fix: minor adjusts * Apply suggestions from code review Co-authored-by: Mariana Bellorín Aguilera <89138244+MarianaAguilera@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Mariana Bellorín Aguilera <89138244+MarianaAguilera@users.noreply.github.com> --------- Co-authored-by: Mariana Bellorín Aguilera <89138244+MarianaAguilera@users.noreply.github.com> --- src/content/docs/en/pages/guides/index.mdx | 1 + .../eleventy-ecommerce-collection.mdx | 101 ++++++++++++++++++ .../understand-azion-templates.mdx | 6 ++ src/content/docs/pt-br/pages/guias/guides.mdx | 1 + .../eleventy-ecommerce-collection.mdx | 101 ++++++++++++++++++ .../templates-visao-geral.mdx | 6 ++ 6 files changed, 216 insertions(+) create mode 100644 src/content/docs/en/pages/guides/marketplace/templates/eleventy-ecommerce-collection.mdx create mode 100644 src/content/docs/pt-br/pages/guias/marketplace/templates/eleventy-ecommerce-collection.mdx diff --git a/src/content/docs/en/pages/guides/index.mdx b/src/content/docs/en/pages/guides/index.mdx index 1008c41f8f..2891a9a91f 100644 --- a/src/content/docs/en/pages/guides/index.mdx +++ b/src/content/docs/en/pages/guides/index.mdx @@ -73,6 +73,7 @@ permalink: /documentation/products/guides/ - [How to deploy a blog based on Gatsby using a template](/en/documentation/products/guides/gatsby-blog-starter-kit/) - [How to deploy an Astro blog using a template](/en/documentation/products/guides/astro-blog-starter-kit/) - [How to deploy an e-commerce based on Astro using a template](/en/documentation/products/guides/astro-ecommerce-collection/) +- [How to deploy an e-commerce based on Eleventy using a template](/en/documentation/products/guides/eleventy-ecommerce-collection/) - [How to deploy and test HTMX on the edge with a template](/en/documentation/products/guides/htmx-boilerplate/) - [How to deploy edge applications with the Angular Boilerplate](/en/documentation/products/guides/angular-boilerplate/) - [How to deploy edge applications with the Astro Boilerplate](/en/documentation/products/guides/astro-boilerplate/) diff --git a/src/content/docs/en/pages/guides/marketplace/templates/eleventy-ecommerce-collection.mdx b/src/content/docs/en/pages/guides/marketplace/templates/eleventy-ecommerce-collection.mdx new file mode 100644 index 0000000000..8c46886c1c --- /dev/null +++ b/src/content/docs/en/pages/guides/marketplace/templates/eleventy-ecommerce-collection.mdx @@ -0,0 +1,101 @@ +--- +title: How to deploy an e-commerce based on Eleventy using templates +description: >- + This guide contains instructions to create an e-commerce application using templates based on Eleventy. +meta_tags: >- + Eleventy, e-commerce, templates, guides, Azion Marketplace, deployment, online store +namespace: docs_guides_eleventy_ecommerce_templates_collection +permalink: /documentation/products/guides/eleventy-ecommerce-collection/ +--- + +import LinkButton from 'azion-webkit/linkbutton'; +import Tag from 'primevue/tag'; + + +Preview + + +The **Eleventy E-commerce Templates** collection offers configurations for building e-commerce applications using templates. These templates are all based on the **Eleventy (11ty)** framework. + +The available templates are: + +- **Eleventy 2 Snipcart**: generate a simple static site with 11ty and JavaScript. It uses version `0.5.4` of Eleventy. +- **11ty and Snipcart for eCommerce**: deploy a new e-commerce with Snipcart integration, based on Eleventy. It uses version `2.0.1` of Eleventy. + +The deployment process for each of these templates creates a GitHub repository for your project, along with an edge application and a domain. This setup enables easy access and management of your e-commerce application through the Azion Edge Platform. + +--- + +## 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. +- These templates use [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 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 templates through the Azion Console. To easily deploy any of them at the edge, click the respective button below. + + + + +--- + +## Setting up the template + +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](/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. Define a name for your edge application. + - The bucket for storage and the edge function will use the same name. + - Use a unique and easy-to-remember name. If the name has already been used, the platform returns an error message. +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. + + diff --git a/src/content/docs/en/pages/main-menu/additional-resources/templates-and-integrations/understand-azion-templates.mdx b/src/content/docs/en/pages/main-menu/additional-resources/templates-and-integrations/understand-azion-templates.mdx index e0d7c36e20..613a7b0d28 100644 --- a/src/content/docs/en/pages/main-menu/additional-resources/templates-and-integrations/understand-azion-templates.mdx +++ b/src/content/docs/en/pages/main-menu/additional-resources/templates-and-integrations/understand-azion-templates.mdx @@ -200,6 +200,12 @@ This template helps you deploy a Docusaurus website integrated with Material UI icon-pos="left" /> +#### Eleventy E-commerce + +The Eleventy E-commerce Templates collection presents a number of templates for deploying an e-commerce application based on Eleventy (11ty). You can choose and deploy the template that best fits your needs and preferences. + + + #### Gatsby Blog Starter Kit This template contains the configurations to create a new blog page based on the Gatsby framework. After the deployment, you can interact with the default posts and interface that already exist in this template and customize them. diff --git a/src/content/docs/pt-br/pages/guias/guides.mdx b/src/content/docs/pt-br/pages/guias/guides.mdx index 42b2875d98..8f5790267b 100644 --- a/src/content/docs/pt-br/pages/guias/guides.mdx +++ b/src/content/docs/pt-br/pages/guias/guides.mdx @@ -104,6 +104,7 @@ permalink: /documentacao/produtos/guias/ - [Como implantar um blog Astro usando um template](/pt-br/documentacao/produtos/guias/astro-blog-starter-kit/) - [Como implantar um blog baseado no Gatsby usando um template](/pt-br/documentacao/produtos/guias/gatsby-blog-starter-kit/) - [Como implantar um e-commerce baseado no Astro usando um template](/pt-br/documentacao/produtos/guias/astro-ecommerce-collection/) +- [Como implantar um e-commerce baseado no Eleventy usando um template](/pt-br/documentacao/produtos/guias/eleventy-ecommerce-collection/) - [Como integrar um banco de dados Turso com Azion usando um template](/pt-br/documentacao/produtos/guias/turso-starter-kit/) - [Como testar o Bot Manager usando um template](/pt-br/documentacao/produtos/guias/bot-manager-starter-kit/) - [Como migrar um site WordPress para o edge com WordPress EdgeAccelerator](/pt-br/documentacao/produtos/guias/wordpress-edgeaccelerator/) diff --git a/src/content/docs/pt-br/pages/guias/marketplace/templates/eleventy-ecommerce-collection.mdx b/src/content/docs/pt-br/pages/guias/marketplace/templates/eleventy-ecommerce-collection.mdx new file mode 100644 index 0000000000..30d1fac399 --- /dev/null +++ b/src/content/docs/pt-br/pages/guias/marketplace/templates/eleventy-ecommerce-collection.mdx @@ -0,0 +1,101 @@ +--- +title: Como implantar um e-commerce baseado no Eleventy usando templates +description: >- + Este guia contém instruções para criar uma aplicação e-commerce usando templates baseados em Eleventy. +meta_tags: >- + Eleventy, e-commerce, templates, guides, Azion Marketplace, deployment, online store +namespace: eleventy +permalink: /documentacao/produtos/guias/eleventy-ecommerce-collection/ +--- + +import LinkButton from 'azion-webkit/linkbutton'; +import Tag from 'primevue/tag'; + + +Preview + + +A coleção de **Templates de E-commerce Eleventy** oferece configurações para criar aplicações de e-commerce usando templates. Esses templates são todos baseados no framework **Eleventy (11ty)**. + +Os templates disponíveis são: + +- **Eleventy 2 Snipcart**: gera um site estático simples com 11ty e JavaScript. Usa a versão `0.5.4` do Eleventy. +- **11ty and Snipcart for eCommerce**: implanta um novo e-commerce com integração do Snipcart, baseado no Eleventy. Usa a versão `2.0.1` do Eleventy. + +O processo de implantação para cada um desses templates cria um repositório do GitHub para seu projeto, junto com uma edge application e um domínio. Essa configuração permite o acesso e gerenciamento fáceis de sua aplicação de e-commerce através da Plataforma de Edge da Azion. + +--- + +## Pré-requisitos + +- Uma [conta GitHub](https://github.com/signup) para se conectar com a Azion e criar seu novo repositório. + - Cada push será implantado automaticamente nesse repositório para manter seu projeto atualizado. +- Estes templates usam [Edge Functions](/pt-br/documentacao/produtos/build/edge-application/edge-functions/), [Application Accelerator](/pt-br/documentacao/produtos/build/edge-application/application-accelerator/), e [Edge Cache](/pt-br/documentacao/produtos/build/edge-application/edge-cache/). Isso pode gerar custos relacionados ao uso. Consulte a [página de preços](/pt-br/precos/) para mais informações. + +--- + +## Implante o template + +Você pode obter e configurar seus templates através do Azion Console. Para implantar um deles facilmente no edge, clique no respectivo botão abaixo. + + + + +--- + +## Configure o template + +No formulário de configuração, você deve fornecer as informações para configurar sua aplicação. Preencha os campos apresentados. + +Os campos identificados com um asterisco são obrigatórios. + +1. Conecte a Azion com sua conta do GitHub. + - Uma janela pop-up será aberta para confirmar a instalação do [Azion GitHub App](/pt-br/documentacao/produtos/guias/azion-github-app/), uma ferramenta que conecta sua conta do GitHub com a plataforma da Azion. + - Defina suas permissões e acesso ao repositório como desejado. +2. Selecione o **Git Scope** com o qual trabalhar. +3. Defina um nome para sua edge application. + - O bucket para armazenamento e a edge function usarão o mesmo nome. + - Use um nome único e fácil de lembrar. Se o nome já tiver sido usado, a plataforma retornará uma mensagem de erro. +4. Clique no botão **Deploy** para iniciar o processo de implantação. + +Durante a implantação, você poderá acompanhar o processo através de uma janela que mostra os logs. Quando estiver completo, a página mostra informações sobre a aplicação e algumas opções para continuar sua jornada. + +:::note +O link para a edge application permite que você a veja no navegador. No entanto, leva um certo tempo para propagar e configurar a aplicação nas localizações de borda da Azion. Pode ser necessário esperar alguns minutos para que a URL seja ativada e para que a página da aplicação seja efetivamente exibida no navegador. +::: + +--- + +## Gerencie o template + +Considerando que essa configuração inicial pode não ser ótima para sua edge application específica, todas as configurações podem ser personalizadas a qualquer momento que você precise, usando a plataforma da Azion. + +Para gerenciar e editar as configurações da sua aplicação edge, siga esses passos: + +1. [Acesse o Azion Console](https://console.azion.com). +2. No canto superior esquerdo, selecione **Products Menu**, o ícone de três linhas horizontais, > **Edge Application**. + - Você será redirecionado para a página **Edge Application**. Ela lista todas as edge application que você criou. +3. Encontre a edge application relacionada ao seu template e selecione-a. + - A lista está organizada alfabeticamente. Você também pode usar a **barra de busca** localizada no canto superior esquerdo da lista; atualmente, ela filtra apenas pelo campo **Application Name**. + +Depois de selecionar a aplicação edge que você trabalhará, você será direcionado para uma página contendo todas as configurações que você pode configurar. + +:::tip +Leia a documentação sobre [gerenciamento de edge application](/pt-br/documentacao/produtos/build/edge-application/primeiros-passos/) para mais detalhes. +::: + +### Adicione um domínio personalizado + +A edge application criada durante a implantação tem um domínio Azion atribuído para torná-la acessível através do navegador. O domínio tem o seguinte formato: `xxxxxxxxxx.map.azionedge.net/`. No entanto, você pode adicionar um domínio personalizado para que os usuários acessem sua edge application através dele. + + diff --git a/src/content/docs/pt-br/pages/menu-principal/recursos-adicionais/templates-e-integracoes/templates-visao-geral.mdx b/src/content/docs/pt-br/pages/menu-principal/recursos-adicionais/templates-e-integracoes/templates-visao-geral.mdx index 6110de4fba..aa17ad2165 100644 --- a/src/content/docs/pt-br/pages/menu-principal/recursos-adicionais/templates-e-integracoes/templates-visao-geral.mdx +++ b/src/content/docs/pt-br/pages/menu-principal/recursos-adicionais/templates-e-integracoes/templates-visao-geral.mdx @@ -201,6 +201,12 @@ O **Docusaurus TypeScript Boilerplate** é um exemplo inicial para implantar um icon-pos="left" /> +#### Eleventy E-commerce + +A coleção Eleventy E-commerce Templates apresenta uma série de templates para implantar uma aplicação de e-commerce baseada no Eleventy (11ty). Você pode escolher e implantar o template que melhor se adapta às suas necessidades e preferências. + + + #### Gatsby Blog Starter Kit Cria uma nova página de blog baseada no framework Gatsby. Após a implantação, você pode interagir com as postagens e interface padrão que já existem neste template e personalizá-las.