diff --git a/docs/getting-started/installing-an-app/en.md b/docs/getting-started/installing-an-app/en.md index b352b983..056b4dc6 100644 --- a/docs/getting-started/installing-an-app/en.md +++ b/docs/getting-started/installing-an-app/en.md @@ -5,34 +5,28 @@ since: 1.33.2 # Prerequisites -Before you begin, make sure you have a deco site ready, and the desired App should be available in the Apps directory. If you're unsure how to achieve this, refer to the [making an app installable tutorial](/docs/en/developing/making-an-app-installable). +Before you begin, make sure you have a ready Deco site, and the desired App should be available in the Apps directory. If you're unsure how to do this, refer to the [tutorial on making an app installable](/docs/en/developing/making-an-app-installable). -## Step 1: Log in to deco Admin +# Apps -Start by logging in to your deco Admin account. Visit [https://deco.cx/admin](https://deco.cx/admin) and enter your credentials. +An `App` allows you to add new functionalities to your site in a straightforward manner. -## Step 2: Choose Your Target Site +# Installing the App -After logging in, select the specific site where you want to install the App. You'll be directed to the site's home. +1. **Access the Deco Admin:** Start by logging into your Deco Admin account. Visit [https://admin.deco.cx](https://admin.deco.cx) and enter your credentials. -## Step 3: Access the "Apps" Section +2. **Choose the Target Site:** After logging in, select the specific site where you want to install the App. You will be directed to the site's homepage. -In the site's home, navigate to the "Apps" section. This section is where you'll find all the Apps available for installation. +3. **Access the "Apps" Section:** On the site's homepage, navigate to the "Apps" section. This is where you will find all the Apps available for installation. Select to view all "available Apps". -## Step 4: Add the App Block +![Apps Section](https://github.com/deco-cx/apps/assets/882438/e2533612-6828-4fb6-9959-96f000ca3537) -Inside the "Apps" section, create a new App block. Give it a name; it's commonly used to specify the version, such as `site@v0` and publish it. +4. **Add an App Block:** Click on "Add" to install an App. This starts the process of creating a block. Configure the block and click on "Create" (give it a name; it's common to use the version, like `site@v0`). -## Step 5: Configure the App +5. **Explore Installed Blocks:** Once installed, you will have access to all the blocks and components that an App includes. These blocks can be integrated into your Deco site to provide additional functionality. -With the App block created, you'll also be prompted to fulfill any required configurations or parameters. +Congratulations! You have successfully installed an App using the Deco Admin. Explore the new capabilities and features that an installed App brings to your Deco site. Feel free to further customize the App or explore other available Apps to expand the functionality of your Deco project. Enjoy managing and enhancing your Deco site! 🚀 -## Step 6: Save and Publish +> You can always change the App settings by clicking on the created block. -After configuring the App block, click "Save and Publish" to apply the changes and install the App on your site. - -## Step 7: Explore the Installed Blocks - -Once the App is installed, you'll have access to all the blocks and components it includes. These blocks can be integrated into your deco site to provide additional functionalities. - -Congratulations! You've successfully installed an App using deco Admin. Explore the newfound capabilities and features that the installed App brings to your deco site. Feel free to customize the App further or explore other available Apps to expand your deco project's functionalities. Enjoy managing and enhancing your deco site! 🚀 +![Changing App Settings](https://github.com/deco-cx/apps/assets/882438/5cf7fe48-89b1-47cd-be82-2f7ff601e640) \ No newline at end of file diff --git a/docs/getting-started/installing-an-app/pt.md b/docs/getting-started/installing-an-app/pt.md index 605a8b3c..51eadde9 100644 --- a/docs/getting-started/installing-an-app/pt.md +++ b/docs/getting-started/installing-an-app/pt.md @@ -7,32 +7,26 @@ desde: 1.33.2 Antes de começar, certifique-se de ter um site deco pronto, e a App desejado deve estar disponível no diretório Apps. Se você não tem certeza de como fazer isso, consulte o [tutorial de tornar uma app instalável](/docs/en/developing/making-an-app-installable). -## Passo 1: Acesse o deco Admin +# Apps -Comece fazendo login na sua conta do deco Admin. Visite [https://deco.cx/admin](https://deco.cx/admin) e insira suas credenciais. +Uma `App` permite adicionar novas funcionalidades no seu site de maneira bem direta. -## Passo 2: Escolha o Site de Destino +# Instalando a app -Após fazer login, selecione o site específico onde deseja instalar o App. Você será direcionado para a página inicial do site. +1. **Acesse o deco Admin:** Comece fazendo login na sua conta do deco Admin. Visite [https://admin.deco.cx](https://admin.deco.cx) e insira suas credenciais. -## Passo 3: Acesse a Seção "Apps" +2. **Escolha o Site de Destino:** Após fazer login, selecione o site específico onde deseja instalar o App. Você será direcionado para a página inicial do site. -Na página inicial do site, navegue até a seção "Apps". Esta é a seção onde você encontrará todos os Apps disponíveis para instalação. +3. **Acesse a Seção "Apps":** Na página inicial do site, navegue até a seção "Apps". Esta é a seção onde você encontrará todos os Apps disponíveis para instalação. Selecione para ver todos os Apps disponíveis. -## Passo 4: Adicione um Bloco da app +![Seção de Apps](https://github.com/deco-cx/apps/assets/882438/e2533612-6828-4fb6-9959-96f000ca3537) -Dentro da seção "Apps", crie um novo bloco da App. Dê a ele um nome; é comum usar a versão, como `site@v0`, e publique-o. +4. **Adicione um Bloco da app:** Clique em adicionar App. Isto inicia o processo de criar um bloco. Configure o bloco e clique em criar. (dê a ele um nome; é comum usar a versão, como `site@v0`). -## Passo 5: Configure a App +5. **Explore os Blocos Instalados:** Depois de instalado, você terá acesso a todos os blocos e componentes que um App inclui. Esses blocos podem ser integrados ao seu site deco para fornecer funcionalidades adicionais. -Com um bloco da app criado, você também será solicitado a preencher quaisquer configurações ou parâmetros necessários. - -## Passo 6: Salve e Publique - -Após configurar o bloco da app, clique em "Salvar e Publicar" para aplicar as alterações e instalar um App no seu site. - -## Passo 7: Explore os Blocos Instalados +Parabéns! Você instalou com sucesso um App usando o deco Admin. Explore as novas capacidades e recursos que um App instalado traz para o seu site deco. Sinta-se à vontade para personalizar o App ainda mais ou explorar outros Apps disponíveis para expandir as funcionalidades do seu projeto deco. Aproveite para gerenciar e aprimorar o seu site deco! 🚀 -Depois de instalado, você terá acesso a todos os blocos e componentes que um App inclui. Esses blocos podem ser integrados ao seu site deco para fornecer funcionalidades adicionais. +> É possível sempre alterar as configurações do Apps clicando no bloco criado. -Parabéns! Você instalou com sucesso um App usando o deco Admin. Explore as novas capacidades e recursos que um App instalado traz para o seu site deco. Sinta-se à vontade para personalizar o App ainda mais ou explorar outros Apps disponíveis para expandir as funcionalidades do seu projeto deco. Aproveite para gerenciar e aprimorar o seu site deco! 🚀 +![Alterando configurações do App](https://github.com/deco-cx/apps/assets/882438/5cf7fe48-89b1-47cd-be82-2f7ff601e640) \ No newline at end of file diff --git a/docs/getting-started/proxy-redirects/en.md b/docs/getting-started/proxy-redirects/en.md index 9a2e0188..b234e81a 100644 --- a/docs/getting-started/proxy-redirects/en.md +++ b/docs/getting-started/proxy-redirects/en.md @@ -13,35 +13,62 @@ By leveraging proxies and redirects, you can optimize content delivery, manage t The overall process involves changing the site route map and attaching a proxy or a redirect depending wether your use case needs one or the other. At the end of the process we should be able to create an example route `/example-proxy` that proxies requests to deco.cx and a `/example-redirect` that redirects you to google.com homepage. Notice the difference: the former will let you in the same domain and the latter will leave your site domain. -## Step by step +## Step by Step -### Adding a Redirect +### Adding a Redirection -1. First, log in to the deco's Admin. Once you're logged in, you can access the _site_ you want to work with. -2. Open the `./routes/[...catchall].tsx` block, which is responsible for **routing** your site. You can access it by using the following link (replace $sitename with your site name): -3. Click on `Add audiences` and a select menu will appear.image -4. Below `Create new`, select the `Audience Everyone` option. -5. A new select menu named `Routes` will appear. Under `Create new`, choose the option _deco-cx/deco/flags/audience.ts@Route[]_. Then click on the `+` button to add a new route.image -6. Fill in the `Path Template` field with the desired route, e.g., `/example-redirect` (ignore the `href` checkbox option for now). -7. In the `Handler` option, select `Redirect Handler` (or $live/handlers/redirect.ts). -8. In the `To` field, enter h`ttps://google.com` or the URL you want to **redirect** to. -9. Choose the type as `temporary` since this redirect may change over time. If the redirect should not change over time, you can select `permanent` (which may result in faster responses since permanent redirects are cached by the user's browser).image -10. Save and publish the changes. +1. First, log in to the Deco Admin. Once logged in, you can access the site you want to work with. -Now you can access and check if the redirect is working. +2. Go to the site's `redirects` configuration. +![Redirects in Admin](https://github.com/deco-cx/apps/assets/882438/29e9f388-2c32-4190-96e5-ac5a8001b68c) -> Please note that if you need to add a new redirect, you will need to repeat the steps from 5 onwards because the audience will already have been created. +3. Click on `Create a redirect` and configure it according to your needs. + +![Create Redirect](https://github.com/deco-cx/apps/assets/882438/63a7d2a4-cc53-47eb-adca-c6cb601e7f41) + +4. Fill in the `From` field with the desired route, for example, `/example-redirect`, and in the `To` field, enter `https://google.com` or the URL to which you want to **redirect**. + +5. Choose the type as `temporary` since this redirection may change over time. If the redirection should not change over time, you can select `permanent` (which may result in faster responses since permanent redirects are cached by the user's browser). + +6. Create the redirect to apply it. + +Now you can access `https://your-site.deco.site/example-redirect` and check if the redirection is working correctly. ### Adding a Proxy -Proxies are utilized when you want to _keep the user_ within the _same website but deliver different content_. **Proxies** enable the sharing of resources under the same domain, providing a unified user experience. This can be particularly useful when you need to serve content from different sources or platforms while maintaining a consistent user interface. Proxies are commonly employed during platform migration processes, allowing you to gradually adopt deco.cx and determine whether a specific page should be proxied or served directly by deco.cx. +Proxies are used when you want to keep the user within the same site but provide different content. **Proxies** allow for sharing resources under the same domain, providing a unified user experience. This can be especially useful when you need to serve content from different sources or platforms while maintaining a consistent user interface. Proxies are commonly used during platform migration processes, allowing you to gradually adopt Deco and decide if a specific page should be proxied or served directly by Deco. + +To create a proxy instead of a redirection, you can follow these steps: + +1. First, log in to the Deco Admin. Once logged in, you can access the site you want to work with. + +2. Open the site `App` for editing. And press to add a new `site map`. + +![Add Site Map](https://github.com/deco-cx/apps/assets/882438/92427ed1-54cb-49f2-88f5-3be8c1c27b8a) + +3. Select the route type as `Route`, and add this new route. + +4. As the `Path template`, select the base of the route (e.g., `/example-proxy`), select the value `Proxy`, and the `URL` as the URL to be proxied (e.g., `https://deco.cx`). + +5. Publish the changes. + +Now, when you access the specified route (for example, `https://your-site.deco.site/example-proxy`), you will be proxied to the specified URL (in this case, `https://deco.cx`). + +### Adding a Redirect File + +Repeat steps 1 and 2 from the previous section. Then: + +1. Upload a file named `redirect.csv` to the project's base. It should have the format as indicated below: + +``` +from,to,type +/example-redirect,/test,temporary +/google,https://www.google.com,permanent +``` -To create a proxy instead of a redirect, you can follow the same steps mentioned above, but with a few changes: -Repeat steps 1 to 5 from the "Adding a Redirect" section. +2. Add the route of type `redirectsFromCsv.ts`. -1. In the "Handler" option, select "Proxy Handler" (or $live/handlers/proxy.ts). -2. In the "To" field, enter the exact URL that should be used as the proxy (e.g., ). -3. Save and publish the changes. +3. Select `redirect.csv` as the redirect file. -Now, when accessing the specified route (e.g., ), you will be proxied to the specified URL (in this case, ). +4. Publish the changes. \ No newline at end of file diff --git a/docs/getting-started/proxy-redirects/pt.md b/docs/getting-started/proxy-redirects/pt.md index 6a241004..0655c3db 100644 --- a/docs/getting-started/proxy-redirects/pt.md +++ b/docs/getting-started/proxy-redirects/pt.md @@ -18,30 +18,57 @@ O processo geral envolve a alteração do mapa de rotas do site e a associação ### Adicionando um Redirecionamento 1. Primeiro, faça login no Admin da deco. Uma vez logado, você pode acessar o _site_ com o qual deseja trabalhar. -2. Abra o bloco `./routes/[...catchall].tsx`, que é responsável pelo **roteamento** do seu site. Você pode acessá-lo usando o seguinte link (substitua `$sitename` pelo nome do seu site): -3. Clique em `Adicionar Audiência` e um menu de seleção será exibido. image -4. Abaixo de `Criar novo`, selecione a opção `Audience Everyone`. -5. Um novo menu de seleção chamado `Routes` será exibido. Em `Criar novo`, escolha a opção _deco-cx/deco/flags/audience.ts@Route[]_. Em seguida, clique no botão `+` para adicionar uma nova rota. image -6. Preencha o campo `Path Template` com a rota desejada, por exemplo, `/example-redirect` (ignore a opção `href checkbox` por enquanto). -7. Na opção `Handler`, selecione `Redirect Handler` (ou $live/handlers/redirect.ts). -8. No campo `To`, insira `https://google.com` ou a URL para a qual deseja **redirecionar**. -9. Escolha o tipo como `temporary`, já que este redirecionamento pode mudar ao longo do tempo. Se o redirecionamento não deve mudar ao longo do tempo, você pode selecionar `permanent` (o que pode resultar em respostas mais rápidas, já que os redirecionamentos permanentes são armazenados em cache pelo navegador do usuário). image -10. Salve e publique as alterações. -Agora você pode acessar `https://seu-site.deco.site/example-redirect` e verificar se o redirecionamento está funcionando corretamente. +2. Entre na configuração de `redirects` do site. +![Redirects no admin](https://github.com/deco-cx/apps/assets/882438/29e9f388-2c32-4190-96e5-ac5a8001b68c) + +3. Pressione `Criar um redirect` e configure de acordo com sua necessidade. + +![Criar redirect](https://github.com/deco-cx/apps/assets/882438/63a7d2a4-cc53-47eb-adca-c6cb601e7f41) + +4. Preencha o campo `De` com a rota desejada, por exemplo, `/example-redirect` e, em `Para`, insira `https://google.com` ou a URL para a qual deseja **redirecionar**. + +5. Escolha o tipo como `temporary`, já que este redirecionamento pode mudar ao longo do tempo. Se o redirecionamento não deve mudar ao longo do tempo, você pode selecionar `permanent` (o que pode resultar em respostas mais rápidas, já que os redirecionamentos permanentes são armazenados em cache pelo navegador do usuário). -> Perceba que, se você precisa adicionar um novo redirect, você precisa repetir os passos de 5. em diante, pois a audiência já terá sido criada. +6. Crie o redirect para aplicá-lo. + +Agora você pode acessar `https://seu-site.deco.site/example-redirect` e verificar se o redirecionamento está funcionando corretamente. ### Adicionando um Proxy Proxies são utilizados quando você deseja _manter o usuário_ dentro do _mesmo site, mas fornecendo um conteúdo diferente_. Os **proxies** permitem o compartilhamento de recursos sob o mesmo domínio, proporcionando uma experiência de usuário unificada. Isso pode ser especialmente útil quando você precisa servir conteúdo de diferentes fontes ou plataformas, mantendo uma interface de usuário consistente. Os proxies são comumente usados durante processos de migração de plataforma, permitindo que você adote gradualmente o Deco e decida se uma página específica deve ser proxied ou servida diretamente pelo Deco. -Para criar um proxy em vez de um redirecionamento, você pode seguir os mesmos passos mencionados acima, com algumas alterações: +Para criar um proxy em vez de um redirecionamento, você pode seguir os seguintes passos: + +1. Primeiro, faça login no Admin da deco. Uma vez logado, você pode acessar o _site_ com o qual deseja trabalhar. + +2. Abra o `App` de site para edição. E pressione para adicionar um novo `site map`. -Repita os passos de 1 a 5 da seção "Adicionando um Redirecionamento". +![Adicionar site map](https://github.com/deco-cx/apps/assets/882438/92427ed1-54cb-49f2-88f5-3be8c1c27b8a) -1. Na opção "Handler", selecione "Proxy Handler" (ou `$live/handlers/proxy.ts`). -2. No campo "To", insira a URL exata que deve ser usada como proxy, por exemplo, `https://deco.cx`. -3. Salve e publique as alterações. +3. Selecione o tipo da rota como `Route`, e adicione essa nova rota. + +4. Como `Path template`, selecione a base da rota (ex.: `/example-proxy`), selecione o valor `Proxy` e a `URL`, como a URL a ser proxiada (ex.: `https://deco.cx`). + +5. Publique as alterações. Agora, ao acessar a rota especificada (por exemplo, `https://seu-site.deco.site/example-proxy`), você será proxied para a URL especificada (neste caso, `https://deco.cx`). + + +### Adicionando um arquivo de redirects. + +Repita os passos de 1 e 2 da seção anterior. Em seguida: + +1. Suba um arquivo como `redirect.csv` para a base do projeto. Ele deve ter o formato indicado abaixo: + +``` +from,to,type +/example-redirect,/test,temporary +/google,https://www.google.com,permanent +``` + +2. Adicione a rota do tipo `redirectsFromCsv.ts`. + +3. Selecione `redirect.csv` como arquivo de redirects. + +4. Publique as alterações. \ No newline at end of file diff --git a/docs/getting-started/releases-revisions/en.md b/docs/getting-started/releases-revisions/en.md index 0b6d68be..5773f3f7 100644 --- a/docs/getting-started/releases-revisions/en.md +++ b/docs/getting-started/releases-revisions/en.md @@ -1,28 +1,55 @@ --- -description: Learn how to restore previous versions of your site +description: Learn how to restore previous versions of your website since: 1.0.0 --- # Revisions -It's very important to have control and autonomy to manage your pages and blocks and to be able to easily make and revert changes if necessary. With that in mind, _deco.cx_ allows you to have access to all versions of pages and blocks, either the ones that are published or the ones that have been changed but aren't published, and guarantees navigating between these versions remains very intuitive. This way, when editing a page or block on your site, you can click on the `Revisions` tab and find out when and by which team member the change was made. +It's very important to have control and autonomy to manage your pages and blocks and have the ability to make and undo changes easily if needed. With that in mind, _deco.cx_ allows you to access the history of all versions of pages and blocks. This way, when editing a page or block on your site, you can click on the `Revisions` tab to find out when and by which team member a change was made. -## Step by step -1. Once you are already logged into the Deco's Admin, you can access the site you want to work with. -2. Access the page or block you want to work with. For instance (remember to replace `$sitename` with your site name): - - If you want to access the `Page List`, go to - - If you want to access the `Blocks List`, go to -3. On the right sidebar of the screen, you can see the page properties and a navigation bar with the `Form`, `JSON` and `Revisions` tabs. -4. By clicking on the `Revisions` tab, you can access a list of versions for this page (or block) and who was responsible for making them. You can also inspect what has changed between different versions by clicking on the version you want. -5. When you make changes to any page or block you need to click on `Save`, otherwise the changes you've made will be lost. -6. Afterwards, a new revision will be generated with the change you just saved. However, it's important to keep in mind that this version is not yet published.image -7. If you want the changes you've made to be published, after saving you need to click on `Publish`, to replace the current published version of your page or to create an A/B test with your changes.image +## Step by Step -# Releases +1. Once you are logged into the Deco admin, you can access the website you want to work on. -`Releases` holds the history of all published versions of your site, and allow you to quickly restore to previous versions if needed. To access the list of published versions, click on the `Releases` tab on the top bar of your site's home page. +2. Access the page or block you want to work on. For instance (remember to replace `$sitename` with your site's name): + - If you want to access the `Page Listing`, go to + - If you want to access the `Section Listing`, go to + - There are other blocks that can be configured and accessed through the block listing at -## Step by step -1. When you access the `Release` tab, you can see a list of releases on the screen, but only one of them is published. -2. Once you publish a revision of any page or block, a **new release** version will be generated. This way, when accessing the `Releases` tab, you'll be able to see the new published version listed among the other ones.image -3. If you prefer to republish a previously published version of a release other than the current one, you can click on `…` and then click on `Publish` to restore your chosen version. image \ No newline at end of file +3. On the right sidebar of the screen, you can see the page properties and a navigation bar with tabs such as `Form`, `JSON`, and `Revisions` (`↻`). + +![Revisions](https://github.com/deco-cx/apps/assets/882438/86b9b319-e314-4928-ac84-db415358ed28) + +4. By clicking on the `Revisions` tab (`↻`), you can access a list of versions for that page (or block) and who was responsible for making them. You can also load the data from a version to use as a basis for the current edit. + +> To restore an old version, simply select the version to be restored and click `Publish`. + +5. When you make changes to any page or block, you need to click `Publish`, otherwise the changes made will be lost. + +6. After that, a new revision will be published with the changes you just saved. + +When you publish a version, it is live! If you need to create a version just to test a page or component, or if it needs gradual and constant work, you can save a draft. A draft is a variant that will never be used to fulfill any user request. + +![Create Draft](https://github.com/deco-cx/apps/assets/882438/c8667427-e2cb-4296-a976-8b9de3ab4ef4) + +If you are satisfied with the work, the draft can replace or take on the role of the original variant (including the default variant). + +![Promote Draft](https://github.com/deco-cx/apps/assets/882438/5da5cd0a-7212-424a-abd1-c91e54938dca) + +So, remember: + +- the latest version is always live and represents the current state of that element or page in production +- a draft is only a variant that is never used to fulfill requests on the site (but can be promoted to do so if the user desires) + +# Releases + +`Releases` holds the history of all published versions of your site and allows you to quickly restore to previous versions if needed. To access the list of published versions, click on the `Releases` tab on the top bar of your site's homepage. + +## Step by Step + +1. When you access the `Releases` tab on the top bar, you can see a list of releases on the screen, but only one of them is published. +2. Once you publish a revision of any page or block, a new release will be generated. Therefore, when you access the `Releases` tab after some published modification, you will be able to see the new published version of the release listed along with the others. + +![Releases](https://github.com/deco-cx/apps/assets/882438/719d710a-61a0-4aaf-b253-556b4195f3e0) + +3. If you prefer to republish a version of the previously published release, different from the current release, you can click on `...` and then click `Publish` to restore the chosen version. \ No newline at end of file diff --git a/docs/getting-started/releases-revisions/pt.md b/docs/getting-started/releases-revisions/pt.md index c0be68a6..3a820705 100644 --- a/docs/getting-started/releases-revisions/pt.md +++ b/docs/getting-started/releases-revisions/pt.md @@ -5,18 +5,41 @@ since: 1.0.0 # Revisões -É muito importante ter controle e autonomia para gerenciar suas páginas e blocos e ter a possibilidade de fazer e desfazer alterações facilmente, caso seja necessário. Pensando nisso, a _deco.cx_ permite que você tenha acesso a todas as versões das páginas e blocos, tantos os publicados quanto os que foram alterados mas não foram publicados, e garante que navegar entre essas versões seja uma experiência simples e intuitiva. Desse modo, ao editar uma página ou bloco do seu site, você pode clicar na aba de `Revisions` e saber quando e por que membro do time tal alteração foi feita. +É muito importante ter controle e autonomia para gerenciar suas páginas e blocos e ter a possibilidade de fazer e desfazer alterações facilmente, caso seja necessário. Pensando nisso, a _deco.cx_ permite que você tenha acesso ao histórico de todas as versões das páginas e blocos. Desse modo, ao editar uma página ou bloco do seu site, você pode clicar na aba de `Revisions` e saber quando e por que membro do time uma alteração foi feita. ## Passo a passo + 1. Uma vez que você já está logado no admin da Deco, você pode acessar o _site_ em que você quer trabalhar. + 2. Acesse a página ou bloco que você quer trabalhar. Por exemplo (lembre-se de substituir `$sitename` pelo nome do seu site): - - Se você quiser ir para a `Listagem de Páginas`, acesse - - Se você ir para a `Listagem de Blocos`, acesse -3. Na barra lateral direita da tela você pode ver as propriedades da página e uma barra de navegação com as abas `Form`, `JSON` e `Revisions`. -4. Ao clicar na aba de `Revisions`, você consegue ter acesso a uma lista de versões para essa página (ou bloco) e quem foi o responsável por realizá-las. Você também pode inspecionar o que mudou entre diferentes versões clicando na versão desejada. -5. Quando você faz alterações em qualquer página ou bloco, você precisa clicar em `Salvar`, caso contrário as alterações feitas serão perdidas. -6. Depois disso, uma nova revisão será criada com as alterações que você acabou de salvar. No entanto, é importante lembrar que essa nova revisão ainda não está publicada. Screen Shot 2023-07-13 at 21 45 12 -7. Se você quer que as alterações feitas sejam publicadas, depois de salvar você precisa clicar em `Publicar` para substituir a página publicada atual por essa nova versão ou criar um teste A/B a partir disso. Screen Shot 2023-07-13 at 21 46 00 + - Se você quiser ir para a `Listagem de Páginas`, acesse + - Se você ir para a `Listagem de Sections`, acesse + - Existem outros blocos que podem ser configurados e podem ser acessados pela listagem de blocos em + +3. Na barra lateral direita da tela você pode ver as propriedades da página e uma barra de navegação com abas como `Form`, `JSON` e `Revisions` (`↻`). + +![Revisões](https://github.com/deco-cx/apps/assets/882438/86b9b319-e314-4928-ac84-db415358ed28) + +4. Ao clicar na aba de `Revisions` (`↻`), você consegue ter acesso a uma lista de versões para essa página (ou bloco) e quem foi o responsável por realizá-las. Você também pode carregas os dados de uma versão para usar como base da edição atual. + +> Para restaurar uma versão antiga, basta selecionar a versão a ser resturada e clicar em `Publicar`. + +5. Quando você faz alterações em qualquer página ou bloco, você precisa clicar em `Publicar`, caso contrário as alterações feitas serão perdidas. + +6. Depois disso, uma nova revisão será publicada com as alterações que você acabou de salvar. + +Ao publicar uma versão, ela está ativa e já é utilizada em produção! Caso precise criar uma versão apenas para testar uma página ou componente, ou que precise de um trabalho gradual e constante, é possível salvar um rascunho. Um rascunho é uma variante mas que nunca será usada para atender qualquer requisição do usuário. + +![Criar rascunho](https://github.com/deco-cx/apps/assets/882438/c8667427-e2cb-4296-a976-8b9de3ab4ef4) + +Caso esteja satisfeito com o trabalho, o rascunho pode substituir ou assumir o papel da variante original (incluindo a variante padrão). + +![Promover rascunho](https://github.com/deco-cx/apps/assets/882438/5da5cd0a-7212-424a-abd1-c91e54938dca) + +Então, lembre-se: + +- a última versão sempre está no ar e representa o estado atual daquele elemento ou página em produção +- um rascunho é somente uma variante que nunca é usada para atender requisições no site (mas que pode ser promovida para fazer isto, caso o usuário assim deseje) # Lançamentos @@ -24,5 +47,8 @@ since: 1.0.0 ## Passo a passo 1. Quando você acessa a aba `Lançamentos` na barra superior, você pode ver uma lista de lançamentos na tela, mas apenas um deles está publicado. -2. Uma vez que você publica uma revisão de qualquer página ou bloco, um novo lançamento será gerado. Desse modo, ao acessar a aba `Lançamentos` após alguma modificação publicada, você poderá ver a nova versão publicada do lançamento listada junto com as demais. Screen Shot 2023-07-13 at 21 48 38 -3. Caso prefira republicar uma versão do lançamento publicado anteriormente, diferente do lançamento atual, você pode clicar em `…` e depois clicar em `Publicar` para restaurar a versão escolhida. Screen Shot 2023-07-13 at 21 49 03 \ No newline at end of file +2. Uma vez que você publica uma revisão de qualquer página ou bloco, um novo lançamento será gerado. Desse modo, ao acessar a aba `Lançamentos` após alguma modificação publicada, você poderá ver a nova versão publicada do lançamento listada junto com as demais. + +![Lançamentos](https://github.com/deco-cx/apps/assets/882438/719d710a-61a0-4aaf-b253-556b4195f3e0) + +3. Caso prefira republicar uma versão do lançamento publicado anteriormente, diferente do lançamento atual, você pode clicar em `…` e depois clicar em `Publicar` para restaurar a versão escolhida. \ No newline at end of file diff --git a/docs/toc.ts b/docs/toc.ts index d89a9219..17e6bf30 100644 --- a/docs/toc.ts +++ b/docs/toc.ts @@ -53,8 +53,8 @@ const tableOfContents: TableOfContents = [ }, { title: { - pt: "Restaurando versões", - en: "Restoring versions", + pt: "Criando rascunhos e Restaurando versões", + en: "Creating drafts and Restoring versions", }, slug: "getting-started/releases-revisions", },