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.

Sign up for GitHub

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

Update docs to admin v2. #201

Merged
merged 3 commits into from
Oct 31, 2023
Merged

Update docs to admin v2. #201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
55f1737
Update docs to admin v2.
matheusgr Oct 31, 2023
1ee965d
Update variants.
matheusgr Oct 31, 2023
c28b499
Custom domains.
matheusgr Oct 31, 2023
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
25 changes: 14 additions & 11 deletions docs/getting-started/creating-a-site/en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,28 @@ description: |

- Read deco.cx's [**Overview**](/docs/en/overview).

> You can always ask for help or more info on our [discord server](https://deco.cx/discord)!

## Create a deco.cx website

1. Login/Signup on [https://deco.cx/admin](https://deco.cx/admin).
2. Create a new **Team** if you aren't part of one yet.
3. Click on **+ Create Site**.
4. Set a name for your site.
5. **Important:** Select the **Start** template.
6. Click on **Create**.
1. Login/Signup on [https://admin.deco.cx/](https://admin.deco.cx/).
2. Choose your site's template.
3. Set a name for your site.
4. Set a name for your team.
5. Click on **+ Create Site**.
6. **Important:** Select the **Start** template.
7. Click on **Create**.

<img width="1512" alt="Creating a site on deco.cx" src="https://github-production-user-asset-6210df.s3.amazonaws.com/18706156/253386927-287e0b0d-5e96-46a3-9396-5cae24519bf3.png">
![Template selection](https://github.com/deco-sites/storefront/assets/882438/4c4323ec-2aec-4b08-a523-32f0761c8a36)

The site creation process will start and, after it finished, you'll see the site's dashboard:

<img width="1512" alt="Site Dashboard on deco.cx" src="https://github.com/deco-cx/deco/assets/18706156/13d2331e-86b2-4db5-b11a-2cff2ac807ac">
![Site Dashboard on deco.cx](https://github.com/deco-cx/apps/assets/882438/cac4147f-b013-40ca-bf68-e28ab40e831a)

## Navigating on your site

Right below **Production Domain** you can see your site's URL. This URL is public and the site is already online.
You can see your site's URL right below your site name. This URL is public and the site is already online.

You should see something similar to https://start.deco.cx, which was the template chosen in the creation process.
You should see something similar to https://deco-sites-start.deno.dev, which was the template chosen in the creation process.

> deco.cx is free up until 50.000 page view/visits per month. Check our [Pricing](https://www.deco.cx/en/pricing) for more info.
> deco.cx is free up until 5.000 page view/visits per month. Check our [Pricing](https://www.deco.cx/en/pricing) for more info.
14 changes: 8 additions & 6 deletions docs/getting-started/creating-a-site/pt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,27 @@ descrição: |

- Leia [**Overview**](/docs/en/overview) da deco.cx.

> Você pode sempre pedir por ajuda ou mais informações no nosso [servidor discord](https://deco.cx/discord)!

## Crie um site deco.cx

1. Faça login/inscreva-se em [https://deco.cx/admin](https://deco.cx/admin).
2. Crie um novo **Time** caso ainda não faça parte de um.
2. Escolha um template para o seu site.
3. Clique em **+ Criar site**.
4. Defina um nome para seu site.
5. **Importante:** Selecione o modelo **Start**.
6. Clique em **Criar**.

<img width="1512" alt="Creating a site on deco.cx" src="https://github-production-user-asset-6210df.s3.amazonaws.com/18706156/253386927-287e0b0d-5e96-46a3-9396-5cae24519bf3.png">
![Seleção de templates](https://github.com/deco-sites/storefront/assets/882438/4c4323ec-2aec-4b08-a523-32f0761c8a36)

O processo de criação do site será iniciado e, após o término, você verá o painel do site:

<img width="1512" alt="Painel do site em deco.cx" src="https://github.com/deco-cx/deco/assets/18706156/13d2331e-86b2-4db5-b11a-2cff2ac807ac">
![Dashboard de site na deco.cx](https://github.com/deco-cx/apps/assets/882438/cac4147f-b013-40ca-bf68-e28ab40e831a)

## Navegando no site

Logo abaixo de **Domínio de Produção** você verá a URL do seu site. Essa URL é pública e o site já está online e acessível..
Logo abaixo no nome do seu projeto, você verá a URL do seu site. Essa URL é pública e o site já está online e acessível.

Você deve ver algo semelhante a https://start.deco.cx, que foi o modelo escolhido no processo de criação.
Você deve ver algo semelhante a https://deco-sites-start.deno.dev, que foi o modelo escolhido no processo de criação.

> A deco.cx é gratuita até 50.000 visualizações/visitas por mês. Verifique nossos [Preços](https://www.deco.cx/en/pricing) para mais informações.
> A deco.cx é gratuita até 5.000 visualizações/visitas por mês. Verifique nossos [Preços](https://www.deco.cx/en/pricing) para mais informações.
53 changes: 43 additions & 10 deletions docs/getting-started/custom-domains/en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,30 +29,63 @@ To add a domain:
- The user needs to be an administrator of the site.
- The user needs to acquire a custom domain from a name server provider that allows `CNAME` configuration.
- The user or administrator of the custom domain needs to create a `CNAME` record as indicated in the validation step.
- ONLY if the domain already has any "CAA" records, it is necessary to add new records.

## Before adding a domain

Additional configuration may be required on your website depending on the integration used.

If the domain has a `CAA` record, you need to add new domains so that we can generate the certificate for your new domain. Important: `If your domain doesn't have CAA records, this step is not necessary (and not recommended)`.

You can check if the domain has these records using the [Google Admin Toolbox Dig](https://toolbox.googleapps.com/apps/dig/#CAA/) or the command `dig yourdomain.com.br caa +short`. If the query doesn't return data (`Record not found!`), skip this step.

If your site has certificates, you need to add the following records, especially the last two (`pki.goog`). Add them to your site's domain (or use `@` as the field name).

```
0 issue "digicert.com; cansignhttpexchanges=yes"
0 issuewild "digicert.com; cansignhttpexchanges=yes"
0 issue "sectigo.com"
0 issuewild "sectigo.com"
0 issue "letsencrypt.org"
0 issuewild "letsencrypt.org"
0 issue "pki.goog; cansignhttpexchanges=yes"
0 issuewild "pki.goog; cansignhttpexchanges=yes"
```

Some domain providers do not accept CAA with `cansignhttpexchanges`. In that case, configure it without this property:

```
0 issue "digicert.com"
0 issuewild "digicert.com"
0 issue "sectigo.com"
0 issuewild "sectigo.com"
0 issue "letsencrypt.org"
0 issuewild "letsencrypt.org"
0 issue "pki.goog"
0 issuewild "pki.goog"
```

Check with your domain provider for further instructions on how to add these records.

## Adding a domain in the admin panel

1. Go to the home page of the site and navigate to the Settings tab.

!["Site home"](https://github.com/deco-sites/starting/assets/882438/c95da5f4-75a8-42ed-b747-674157c52c80)
![Site settings](https://github.com/deco-cx/apps/assets/882438/7c60ddbd-7164-42ea-bd16-d8c5d70603df)

2. In Settings, under the Domains listing, check that there is a `deco.site` domain and add an existing domain.

!["Settings tab"](https://github.com/deco-sites/starting/assets/882438/3cf4102a-d9f3-49d6-aaa0-8aeac5e064b6)
2. In Settings, under the Domains listing, check that there is a `deco.site` domain and add an existing domain. **Contact us if you don't have a `deco.site` domain**.

3. Add your domain for the site in the opened modal. The domain should only be the name, without any protocol (http/https) or slashes. Wait for the initial configuration process.

!["Add domain"](https://github.com/deco-sites/starting/assets/882438/4b2a6b1e-a711-4733-9779-367ac0141e41)
![Add domain](https://github.com/deco-cx/apps/assets/882438/8c19ae5c-e522-4a60-9b8b-28e4815cced6)

4. After adding, the domain is registered with Deco but is not yet operational. You now need to set up the domain. Under `...`, click on setup to view the configuration instructions.

!["Domain setup"](https://github.com/deco-sites/starting/assets/882438/ac14645d-6f59-45cf-ae6e-c918eec7247f)

5. Add the domain configuration to your domain server. This represents a `CNAME` record from the custom domain to the deco domain. In the example, this would be a record from the domain `example.dirlididi.org` to `test-fashionmgr.deco.site`.
5. Add the domain configuration to your domain server. This represents a `CNAME` record from the custom domain to the deco domain. In the example, this would be a record from the domain `www.example.com` to `startest.deco.site`.

![CNAME configuration](https://github.com/deco-sites/starting/assets/882438/98f2505f-db78-42e8-9c5c-5350360f7495)
![Domain setup](https://github.com/deco-cx/apps/assets/882438/0d9d876e-2a5e-4e05-8767-dc77e69c548b)

6. Once configured, click on validate configuration for Deco to verify if the record was set up correctly. The certificate configuration step may fail, but if that happens, it will be retried in the background.
6. Once configured, click on validate configuration for Deco to verify if the record was set up correctly. Important: The domain will remain in an "awaiting" state until we complete the configuration on our infrastructure.

7. Wait a few minutes and test accessing your domain in the browser.

Expand Down
56 changes: 44 additions & 12 deletions docs/getting-started/custom-domains/pt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,39 +29,71 @@ Para adicionar um domínio:
- o usuário precisa ser administrador do site
- o usuário precisa contratar um domínio próprio em um servidor de nomes que permita configuração de `CNAME`
- o usuário ou administrador do domínio próprio precisa criar um apontamento `CNAME` indicado na etapa de validação
- APENAS caso o domínio já tenha algum apontamento `CAA`, é preciso adicionar novos apontamentos

## Adicionando um domínio no admin
## Antes de adicionar um domínio

1. Entre na página inicial do site, e navegue para a aba de Configurações.
Pode ser necessária alguma configuração adicional em seu site dependendo da integração utilizada.

Caso o domínio tenha algum apontamento `CAA`, é preciso adicionar novos domínios para que possamos gerar o certificado do seu novo domínio. Importante: `caso seu domínio não tenha apontamentos CAA, esta etapa não é necessária (e não é recomendada)`.

É possível verificar se o domínio tem esses apontamentos através da ferramenta [Google Admin Toolbox Dig](https://toolbox.googleapps.com/apps/dig/#CAA/) ou o comando `dig seudominio.com.br caa +short`. Caso a consulta não retorne dados (`Record not found!`), ignore esta etapa.

Caso seu site tenha certificados, é preciso adicionar os registros abaixo, especialmente os dois últimos (`pki.goog`). Adicione no domínio do seu site (ou `@` como nome do campo).

```
0 issue "digicert.com; cansignhttpexchanges=yes"
0 issuewild "digicert.com; cansignhttpexchanges=yes"
0 issue "sectigo.com"
0 issuewild "sectigo.com"
0 issue "letsencrypt.org"
0 issuewild "letsencrypt.org"
0 issue "pki.goog; cansignhttpexchanges=yes"
0 issuewild "pki.goog; cansignhttpexchanges=yes"
```

!["Home do site"](https://github.com/deco-sites/starting/assets/882438/c95da5f4-75a8-42ed-b747-674157c52c80)
Alguns provedores de domínios não aceitam o CAA com `cansignhttpexchanges`, neste caso, configure sem essa propriedade:

2. Em Configurações, na listagem de Domínios, verifique que há um domínio `deco.site` e adicione um domínio existente.
```
0 issue "digicert.com"
0 issuewild "digicert.com"
0 issue "sectigo.com"
0 issuewild "sectigo.com"
0 issue "letsencrypt.org"
0 issuewild "letsencrypt.org"
0 issue "pki.goog"
0 issuewild "pki.goog"
```

!["Aba de configurações"](https://github.com/deco-sites/starting/assets/882438/3cf4102a-d9f3-49d6-aaa0-8aeac5e064b6)
Veja mais instruções no seu provedor de domínios em como adicionar esses campos.

## Adicionando um domínio no admin

1. Entre na página inicial do site, e navegue para a aba de Configurações.

![Configuraçãos do site](https://github.com/deco-cx/apps/assets/882438/7c60ddbd-7164-42ea-bd16-d8c5d70603df)

2. Em Configurações, na listagem de Domínios, verifique que há um domínio `deco.site` e adicione um domínio existente. **Caso não tenha um domínio `deco.site`, entre em contato conosco**.

3. Adicione o domínio próprio do site no modal aberto. O domínio deve ser apenas o nome, sem protocolo (http/https) ou barras. Aguarde o processo de configuração inicial.

!["Adicionar domínio"](https://github.com/deco-sites/starting/assets/882438/4b2a6b1e-a711-4733-9779-367ac0141e41)
![Adicionar domínio](https://github.com/deco-cx/apps/assets/882438/8c19ae5c-e522-4a60-9b8b-28e4815cced6)

4. Depois da adição, o domínio está registrado na deco, mas ainda não é operante. É preciso agora fazer o setup do domínio. Em `...`, clicando em setup, haverá instruções de configuração.

!["Validação do domínio"](https://github.com/deco-sites/starting/assets/882438/ac14645d-6f59-45cf-ae6e-c918eec7247f)

5. Adicione a configuração de domínio no seu servidor de domínios. Isto representa um apontamento `CNAME` do domínio própio, para o domínio da deco. No exemplo, isto representa um apontamento do domínio `example.dirlididi.org` para `test-fashionmgr.deco.site`.
5. Adicione a configuração de domínio no seu servidor de domínios. Isto representa um apontamento `CNAME` do domínio própio, para o domínio da deco. No exemplo, isto representa um apontamento do domínio `www.example.com` para `startest.deco.site`.

![Configuração do CNAME](https://github.com/deco-sites/starting/assets/882438/98f2505f-db78-42e8-9c5c-5350360f7495)
![Validação do domínio](https://github.com/deco-cx/apps/assets/882438/0d9d876e-2a5e-4e05-8767-dc77e69c548b)

6. Uma vez configurado, clique em validar configuração para que a deco valide se o apontamento foi corretamente realizado. A etapa de configuração de certificados pode falhar, mas, caso isso ocorra, será tentada novamente em background.
6. Uma vez configurado, clique em validar configuração para que a deco valide se o apontamento foi corretamente realizado. **Importante: O domínio continuará no estado de em espera por validação até que o apontamento seja realizado na nossa infraestrutura**.

7. Aguarde alguns minutos e teste acessar seu domínio no browser.

# Erros Comuns

## O domínio não é validado

Verifique se o mesmo foi cadastrado corretamente no servidor de nomes. Use uma ferramenta como o ][DNS da google](https://dns.google/) para verificar se há um registro de `CNAME` apontando o domínio corretamente para um domínio `deco.site`.
Verifique se o mesmo foi cadastrado corretamente no servidor de nomes. Use uma ferramenta como o ][DNS da google](https://dns.google/) para verificar se há um registro de `CNAME` apontando o domínio corretamente para um domínio `deco.site`. Alguns provedores de domínios podem levar até 12 horas para efetivar o novo apontamento.

## Após a validação, as configurações ainda exibem meu domínio como "Awaiting"

Expand Down
48 changes: 23 additions & 25 deletions docs/getting-started/updating-seo/en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,44 +1,42 @@
---
description: |
How to edit a block in deco.cx
How to edit a block in deco.cx
---

Using deco.cx's Admin you can change the site's content without needing to change the code, thanks to the [Blocks](/docs/en/concepts/blocks) concept.
Let's begin updating the website information.
deco.cx allows you, through the Admin, to change content without the need for code changes, and this is done through the concept of [Blocks](/docs/en/concepts/blocks).

The first Block we can edit is the **SEO**, a saved Section that is used by the site's home page. This block configures important metadata about the page such as **title, description and thumbnail** (this information is used in social media previews).
The first Block we can edit is the **site**,
an [App](/docs/en/concepts/app) from deco that configures and prepares a project to operate as a website on the internet. This block configures important metadata about the page, including SEO data and title, description, and thumbnail (this information is used in social media previews).

Conveniently, you can preview how **SEO** is set up in the site's dashboard.
Conveniently, on the Site detail page in deco, you can preview how the **SEO** is configured.

Click on **Edit** on the top right to change its data. You will be redirected to the block editing page.
To edit it, click on **Edit** in the upper right corner. You will be redirected to the block editing page.

<img width="1401" alt="image" src="https://github-production-user-asset-6210df.s3.amazonaws.com/18706156/258239685-81217494-3b40-4025-9385-672cab77008e.png ">
![SEO Editing](https://github.com/deco-cx/apps/assets/882438/c7986877-6c2c-4f21-90e6-3634c73f22f6)

Our block editor is divided into two sections:

1. **Preview**: see how your block will be rendered, on the left. _(or some helpful UI if you're editing metadata)._
2. **Form**: edit the information that was made available by developers.
1. **Form**: edit the information that the people who created the block made available for editing on the right sidebar.
2. **Preview**: when applicable, preview how your block will be rendered on the left side.

In the page's _topbar_, you have access to:
- **URL bar**: test specific URLs for the block you are editing (useful for product pages, for example).
- **Performance Metrics:** check which resources this block is using and the amount of Javascript sent to the browser.
- **View/Edit Toggle**: Disable automatic _overlay_ in preview to test interactive block elements.
In the top bar of the page, you have access to:
- **Address bar**: test specific URLs for the block you are editing (useful for product pages, for example).

And in the sidebar, you can select other views of the page:
- **Performance Metrics:** see which resources this block is using and the amount of JavaScript being sent to the browser.
- **Revisions:** access the version history of the edited content.
- **JSON Editor:** edit form data as JSON.
- **Preview mode:**: disable the automatic overlay on the preview to test interactive elements of the block.

<img width="1512" alt="image" src="https://github-production-user-asset-6210df.s3.amazonaws.com/18706156/258239802-e6bc0f12-a996-4867-930a-df76daebdd9d.png ">
![editor](https://github.com/deco-cx/apps/assets/882438/ebcee0fc-1d97-4b2d-a5e9-54a873d88b1e)

All changes you make in the form are **automatically reflected** in the preview on the left. When you are editing pages, you can also use the preview to select specific sections and reorder them directly on the page.

Any changes you make to the form are **automatically reflected** in the preview on the left. When you're editing pages, you can also use preview to select specific Sections and reorder them right on the page.
## Editing SEO

## Editing the SEO
Edit the title, description, and image of your site's SEO according to what you are building and ensure that social media previews are as expected. You can try different versions to see what suits you best.

Edit your site's SEO title, description, and image to suit what you're building, and ensure social media previews behave as expected. You can test different versions to see what fits best.
After that, **click the Publish button** in the upper right to create a new revision of this block. Revisions are immutable versions of the data edited in deco and are used to track and roll back changes over time. Learn more about them [here](/docs/en/getting-started/releases-revisions).

After that, **click the Save button** on the top right to create a new revision of this block. Revisions are immutable versions of the edited data in the deco and are meant to be able to track and revert changes over time. Learn more about [here](/docs/en/getting-started/releases-revisio ns).

## Publishing the changes

To actually change your site's SEO _meta tags_, you need to publish the current revision you just saved. **Click the Publish button** to make the changes effective.

<img width="384" alt="image" src="https://github-production-user-asset-6210df.s3.amazonaws.com/18706156/258240949-394a198c-f25a-4a83-80a4-76f0aecf6b99.png ">

Ready! Now your site has up-to-date SEO data and you've learned how to edit a block in deco.cx.
There you go! Now your site has updated SEO data, and you have learned how to edit a block in deco.cx.
Loading
Loading