Pular para o conteúdo principal

FAQ

Aqui você encontrará uma coleção de perguntas frequentes acompanhadas de respostas detalhadas sobre o conteúdo apresentado.

Quais ferramentas a NDL disponibiliza para documentação?​

A NDL oferece duas ferramentas principais:

  • Docusaurus: Para criar portais de documentação estáticos, ideais para conteúdos técnicos e de referência.
  • Confluence: (em breve) Para documentações dinâmicas e colaborativas.

Quais conhecimentos são recomendados antes de começar a usar o Docusaurus?​

É importante ter noções básicas de:

  • Git
  • Markdown
  • JavaScript
  • CSS

Como clonar um repositório para criar um portal de documentação?​

  1. Acesse o repositório do produto.
  2. Clique em Clone e copie a URL.
  3. No terminal, navegue até a pasta desejada e execute o comando git clone <URL_DO_REPOSITORIO>.

Referência

Como criar uma nova página no Docusaurus?​

  1. No diretório docs/, crie um arquivo .md.
  2. Adicione um cabeçalho YAML com título, autor e tags.
  3. Insira o conteúdo da página e salve o arquivo.

Referência

Como adicionar uma página ao menu lateral no Docusaurus?​

  1. Abra o arquivo custom-sidebar.js.
  2. Adicione um objeto com type, id e label da página.
  3. Salve o arquivo.

Referência

Onde posso solicitar a criação de um repositório para o meu produto?​

Caso o repositório do seu produto não esteja disponível, você pode solicitar a criação aqui.

Preciso configurar o portal toda vez que fizer uma alteração?​

Não, o portal precisa ser configurado apenas uma vez. Após isso, ao realizar o clone do repositório, todas as configurações já estarão prontas.

Preciso configurar o portal toda vez que fizer uma alteração?​

Não, o portal precisa ser configurado apenas uma vez. Após isso, ao realizar o clone do repositório, todas as configurações já estarão prontas.

Como posso testar minhas alterações antes de enviá-las para produção?​

Você pode testar suas alterações de duas maneiras:

  1. Durante o desenvolvimento
    Utilize o comando npm run start para iniciar um servidor local e visualizar as mudanças em tempo real.
  2. Após finalizar o desenvolvimento
    Gere o build localmente com o comando npm run build e, em seguida, utilize npm run serve para testar o conteúdo em um ambiente simulado de produção.
Etiquetas:
Última atualização em