From e5c7dfe04715989ebd3b92e1a96f4fc847755242 Mon Sep 17 00:00:00 2001 From: Guilherme Afonso Oliveira Date: Tue, 24 Dec 2024 12:17:40 -0300 Subject: [PATCH] [EDU-5800] Vuepress Templates Collection guide (#1401) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat: create vuepress templates collection * fix: change file name * feat: add link to guides home * feat: add link to templates overview * Apply suggestions from code review Co-authored-by: Mariana Bellorín Aguilera <89138244+MarianaAguilera@users.noreply.github.com> * Apply suggestions from code review * Update src/content/docs/en/pages/guides/marketplace/templates/vuepress-templates-collection.mdx * Update src/content/docs/pt-br/pages/guias/marketplace/templates/vuepress-templates-collection.mdx * Update src/content/docs/pt-br/pages/guias/marketplace/templates/vuepress-templates-collection.mdx --------- Co-authored-by: Mariana Bellorín Aguilera <89138244+MarianaAguilera@users.noreply.github.com> --- src/content/docs/en/pages/guides/index.mdx | 1 + .../vuepress-templates-collection.mdx | 122 ++++++++++++++++++ .../understand-azion-templates.mdx | 6 + src/content/docs/pt-br/pages/guias/guides.mdx | 1 + .../vuepress-templates-collection.mdx | 122 ++++++++++++++++++ .../templates-visao-geral.mdx | 6 + 6 files changed, 258 insertions(+) create mode 100644 src/content/docs/en/pages/guides/marketplace/templates/vuepress-templates-collection.mdx create mode 100644 src/content/docs/pt-br/pages/guias/marketplace/templates/vuepress-templates-collection.mdx diff --git a/src/content/docs/en/pages/guides/index.mdx b/src/content/docs/en/pages/guides/index.mdx index 82ffc670e1..55e46bf7a3 100644 --- a/src/content/docs/en/pages/guides/index.mdx +++ b/src/content/docs/en/pages/guides/index.mdx @@ -72,6 +72,7 @@ permalink: /documentation/products/guides/ - [How to block Tor Exit Nodes requests using a template](/en/documentation/products/guides/bot-manager-lite-and-tor-block-starter-kit/) - [How to create a WordPress website from scratch with WordPress InstaCreator](/en/documentation/products/guides/wordpress-instacreator/) - [How to deploy a blog based on Gatsby using a template](/en/documentation/products/guides/gatsby-blog-starter-kit/) +- [How to deploy a web application based on VuePress using templates](/en/documentation/products/guides/vuepress-templates-collection/) - [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/) diff --git a/src/content/docs/en/pages/guides/marketplace/templates/vuepress-templates-collection.mdx b/src/content/docs/en/pages/guides/marketplace/templates/vuepress-templates-collection.mdx new file mode 100644 index 0000000000..18c41402cc --- /dev/null +++ b/src/content/docs/en/pages/guides/marketplace/templates/vuepress-templates-collection.mdx @@ -0,0 +1,122 @@ +--- +title: How to deploy a web application based on VuePress using templates +description: >- + This guide contains instructions to deploy a web application using templates based on VuePress. +meta_tags: >- + VuePress, blog, templates, guides, Azion Marketplace, deployment, static site +namespace: docs_guides_vuepress_templates_collection +permalink: /documentation/products/guides/vuepress-templates-collection/ +--- + +import LinkButton from 'azion-webkit/linkbutton'; +import Tag from 'primevue/tag'; + + +Preview + + +The **VuePress Templates** collection offers configurations for deploying web applications using templates. These templates are all based on the **VuePress** framework. + +The available templates are: + +- **VuePress Blog with Hope Theme**: create a VuePress-based blog with the Hope Theme. It uses version `2.0.0` of VuePress. +- **VuePress Docs with Hope Theme**: create a VuePress-based documentation website. It uses version `2.0.0` of VuePress. +- **VuePress Moefy**: create a VuePress website with animations. It uses version `1.9.9` of VuePress. +- **VuePress Live2D Plus**: create a VuePress documentation website. It uses version `2.0.0` of VuePress. +- **VuePress Solid**: create a static site with VuePress. It uses version `2.0.0` of VuePress. + +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 VuePress 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. +- 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 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 set up 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 9325b6d31e..769ea0a30d 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 @@ -590,6 +590,12 @@ The **Vue3/Vite Boilerplate** accelerates the deployment of an application based icon-pos="left" /> +#### VuePress Templates collection + +The VuePress Templates collection presents various templates for deploying web applications based on VuePress. You can choose and deploy the template that best suits your needs and preferences. + + + #### Webpage to PDF Resume This template allows you to easily deploy an online resume based on the Webpage to PDF Resume project. diff --git a/src/content/docs/pt-br/pages/guias/guides.mdx b/src/content/docs/pt-br/pages/guias/guides.mdx index 780853a29f..2fadce6719 100644 --- a/src/content/docs/pt-br/pages/guias/guides.mdx +++ b/src/content/docs/pt-br/pages/guias/guides.mdx @@ -120,6 +120,7 @@ permalink: /documentacao/produtos/guias/ - [Como implantar um e-commerce baseado no Hugo usando um template](/pt-br/documentacao/produtos/guias/hugo-ecommerce-collection/) - [Como implantar um e-commerce baseado no Jekyll usando um template](/pt-br/documentacao/produtos/guias/jekyll-ecommerce-collection/) - [Como implantar um e-commerce baseado no Next.js usando um template](/pt-br/documentacao/produtos/guias/next-js-ecommerce-collection/) +- [Como implantar uma aplicação web baseada em VuePress usando templates](/pt-br/documentacao/produtos/guias/vuepress-templates-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 Lite usando um template](/pt-br/documentacao/produtos/guias/bot-manager-lite-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/vuepress-templates-collection.mdx b/src/content/docs/pt-br/pages/guias/marketplace/templates/vuepress-templates-collection.mdx new file mode 100644 index 0000000000..ffcc92a783 --- /dev/null +++ b/src/content/docs/pt-br/pages/guias/marketplace/templates/vuepress-templates-collection.mdx @@ -0,0 +1,122 @@ +--- +title: Como fazer o deploy de uma aplicação web baseada em VuePress usando templates +description: >- + Este guia contém instruções para implantar uma aplicação web usando templates baseados em VuePress. +meta_tags: >- + VuePress, blog, templates, guias, Azion Marketplace, deployment, site estático +namespace: docs_guides_vuepress_templates_collection +permalink: /documentacao/produtos/guias/vuepress-templates-collection/ +--- + +import LinkButton from 'azion-webkit/linkbutton'; +import Tag from 'primevue/tag'; + + +Preview + + +A coleção **VuePress Templates** oferece configurações para implantar aplicações web usando templates. Estes templates são todos baseados no framework **VuePress**. + +Os templates disponíveis são: + +- **VuePress Blog with Hope Theme**: crie um blog baseado em VuePress com o tema Hope. Utiliza a versão `2.0.0` do VuePress. +- **VuePress Docs with Hope Theme**: crie um site de documentação baseado em VuePress. Utiliza a versão `2.0.0` do VuePress. +- **VuePress Moefy**: crie um site VuePress com animações. Utiliza a versão `1.9.9` do VuePress. +- **VuePress Live2D Plus**: crie um site de documentação com VuePress. Utiliza a versão `2.0.0` do VuePress. +- **VuePress Solid**: crie um site estático com VuePress. Utiliza a versão `2.0.0` do VuePress. + +O processo de deploy para cada um desses templates cria um repositório GitHub para seu projeto, junto com uma edge application e um domínio. Esta configuração permite fácil acesso e gerenciamento da sua aplicação 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/documentacao/produtos/precos/) para mais informações. + +--- + +## Implante o template + +Você pode obter e configurar seus templates através do Azion Console. Para fazer o deploy de qualquer um deles no edge facilmente, clique no respectivo botão abaixo. + + + + + + + +--- + +## Configure o template + +No formulário de configuração, você deve fornecer as informações para personalizar 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 edge locations 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 applications 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 ajustar. + +:::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 16abdb779a..2713d5e4cb 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 @@ -592,6 +592,12 @@ O **Vue3/Vite Boilerplate** acelera a implantação de uma aplicação baseada n icon-pos="left" /> +#### VuePress Templates Collection + +A coleção **VuePress Templates** apresenta uma série de templates para implantar aplicações web baseadas em VuePress. Você pode escolher e implantar o template que melhor se adapta às suas necessidades e preferências. + + + #### Webpage to PDF Resume Este template permite implantar facilmente um currículo online baseado no projeto Webpage to PDF Resume.