Guides

Disponibilize publicamente guias, referências e qualquer outro documento em seu portal utilizando Guides.

Guides funciona como uma plataforma de desenvolvimento de sites, permitindo que você crie livremente conteúdos que façam sentido para você e seus parceiros.

Criando uma nova página

Siga os passos abaixo para criar uma nova página de Guides para o seu portal.

  1. Clique em + ao lado de Pages.
    Você também pode criar páginas em hierarquia. Clique em + ao lado do nome de uma página existente e a nova página ficará abaixo dela (página filha).

    detalhe da página Guides com lista de páginas

  2. Informe o nome da página. Este campo é obrigatório.
    parte da tela guides com o campo page name ao centro

  3. Selecione o papel (role) que o usuário deverá ter para visualizar e acessar o guia. Este campo é obrigatório. Leia sobre atribuição de papéis (roles).

    parte da tela guides com o campo role ao centro

  4. Crie o conteúdo da nova página no campo abaixo da barra de ferramentas.
    O texto deve ter no mínimo 3 caracteres e tamanho máximo de 5 MB.

  5. Clique em SAVE para salvar as alterações ou em BACK para voltar.
    Se você voltar sem salvar, as alterações serão perdidas.

  6. Habilite Publish page para que as alterações sejam publicadas.
    Os passos 5 e 6 não são obrigatórios. Você pode publicar a página em outro momento.

  7. Clique em icone representando link para copiar o link para a página criada.

    animação com sequência para criar e publicar nova página


Identifique quais páginas ainda não foram publicadas buscando por imagem de uma nuvem com um risco em diagonal em cima dela ao lado do nome da página.

Enquanto Public page estiver habilitada, sua página ficará publicada. As atualizações feitas e salvas serão aplicadas a cada vez que você clicar em SAVE, sem necessidade de publicar novamente.

É possível alterar a ordem e a hierarquia das páginas facilmente. Basta clicar e arrastar, movendo a página para onde desejar.

Atribuição de papéis (roles)

A atribuição de papéis permite controlar de forma precisa quem pode visualizar e acessar cada guia. Com esse recurso, administradores definem permissões específicas, garantindo que os usuários vejam apenas o conteúdo relevante para suas funções.

Principais vantagens:

  • Maior proteção para informações sensíveis e configurações do sistema.

  • Personalização granular de permissões conforme as necessidades de cada grupo.

  • Controle eficiente sobre a disponibilidade do conteúdo, seja público ou restrito.

Os papéis são configurados durante a criação/edição de um guia no Portal Manager.

Há dois papéis pré-definidos no sistema:

  • Authenticated: papel padrão (default role), que permite o acesso ao guia somente por usuários autenticados.

  • Public: papel que permite o acesso ao guia por qualquer usuário, incluindo não autenticados (sem necessidade de login).

Você pode ainda criar papéis customizados definindo permissões dedicadas para o consumo de diferentes públicos (internos, parceiros, clientes, etc.).

Para criar um papel customizado, siga os passos abaixo:

  1. Acesse a tela Settings pelo menu lateral esquerdo.

  2. Selecione a aba Roles na parte superior da tela.

  3. Clique em + NEW ROLE para criar um novo papel.

Consulte a documentação sobre a criação de novos papéis.
  • Papéis customizados exigem autenticação do usuário.

  • É possível associar um ou mais papéis a cada guia.

  • Guias com o papel "public" ficam visíveis para todos os usuários, incluindo não autenticados. Essa visibilidade se estende automaticamente a todos os sub-guias.

  • Guias com papéis diferentes de "public" ficam visíveis apenas para usuários autenticados que possuam pelo menos um dos papéis configurados. Essa restrição se aplica tanto ao guia quanto aos seus sub-guias.

  • Usuários que não possuam nenhum dos papéis configurados não conseguirão visualizar o guia nem seus sub-guias.

Como funciona a herança de papéis e visibilidade entre guias

  • Subguias herdam automaticamente a visibilidade do guia principal e, por isso, não exibem a opção de configuração de papéis.

  • Ao mover um guia principal para dentro de outro guia, ele se torna um subguia e passa a usar automaticamente os papéis do novo guia pai.

  • Ao mover um subguia para outro guia principal, ele assume automaticamente os papéis do novo pai.

  • Ao transformar um subguia em guia principal, ele mantém os papéis anteriores, evitando liberar acesso indevido a usuários sem permissão.

Editando uma página

Independente da página estar publicada ou não, você pode sempre editá-la.

Clique no nome da página e, em seguida, clique em EDIT.

Deletando uma página

Para deletar uma página, clique no nome da página e, em seguida, clique em imagem de uma lixeira.

Alternativamente, você pode apenas tirar a publicação do ar. Para isso, clique no nome da página e, em seguida, desabilite Publish page.

Barra de Ferramentas

Você verá a barra de ferramentas ao criar uma nova página ou editar uma página existente.

A barra de ferramentas dá acesso a diversos comandos para personalização e formatação da sua página.

imagem com a barra de ferramentas

Comando

Descrição

Estilo do parágrafo

caixa para escolha do estilo do parágrafo

Aplica uma das formatações: parágrafo simples, título 1, 2 ou 3 em um bloco de texto.

Código fonte

icone indicando código fonte mais a palavra Source

Permite ver ou editar o conteúdo da página em código fonte.

Negrito

letra B maiúscula em negrito

Coloca o texto em negrito. O atalho CTRL+B também pode ser usado.

Itálico

letra I maiúsucla em itálico

Coloca o texto em itálico. O atalho CTRL+I também pode ser usado.

Tachado

letra S tachada

Deixa o texto tachado (com um risco em cima do texto)

Código

sinal de menor e maior

Formata texto para indicar trecho com código: altera fonte para courier new e fundo para cinza. Selecione o trecho que deseja colocar nessa formatação.

Bloco de código

sinal de menor e maior no canto inferior de uma página com identações

Formata parágrafo para indicar trecho com código: altera fonte para courier new e cria uma área retangular com fundo cinza e indicação da linguagem do código. Selecione a linguagem no menu dropdown

Link

icone para link

Insere link. Informe o link e clique no check mark para salvar ou no X para cancelar.

Bulleted list

ícone para bullted list

Formata as linhas selecionadas como lista com bullet points.

Lista numerada

ícone para lista numerada

Formata as linhas selecionadas como lista numerada

Lista de tarefas

ícone para lista de tarefas

Formata as linhas selecionadas como lista de tarefas.

Imagem

ícone para imagem

Abre caixa de diálogo para selecionar arquivo de imagem.

Citação

imagem de aspas duplas

Formata texto para indicar que é uma citação: movimenta indexação e inclui uma linha vertical ao lado esquerdo do texto.

Tabela

icone de tabela com dropdown

Abre área para escolha do tamanho da tabela.

Caracteres especiais

letra grega ômega

Abre área para escolha de caracteres especiais.

Desfazer e refazer

três poontos dispostos verticalmente

Exibe comandos para desfazer e refazer uma alteração. Os atalhos CTRL+Z e CTRL+Y também podem ser usados.

Página publicada

O link para a página publicada fica disponível no canto superior direito da tela, ao lado de Publish page, como ilustra a imagem abaixo.

tela de guides do developer portal com página aberta para ser editada

O acesso para as páginas publicadas em Guides é público. Não é necessário ter acesso de desenvolvedor.

As páginas ficam disponíveis no seu portal, em Guides, como ilustra a imagem abaixo.

tela do portal com as páginas publicadas com destaque para guides

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]