Docusaurus

Há alguns passos antes de se iniciar na criação da documentação com o Docusaurus, nesse Documentos iremos passar por todos eles, afim de informar os usuários que irão alimentar a plataforma.

Instalação do node

Antes de iniciar o docusaurus nós precisamos instalar o node! o mesmo pode ser baixado por esse link: https://nodejs.org/en/download/ Após o download ter sido efetuado seguir o processo de instalação normal do node.

Instalando o docusaurus

Vamos abrir o cmd como administrador, selecionar o seu usuário no diretório e executar o comando:

npm install --global docusaurus-init

Pronto agora o docusaurus foi instalado globalmente na sua máquina.

Clonando o repósitório git.

Irá acessar o link: https://dev.azure.com/grupobarcelos/Intranet/_git/Docusaurus?version=GBmaster clicar em clone e copiar o link que lá está, após isso vai abrir o git bash Vai selecionar a pasta code do seu usuário com o git executando o comando:

cd code

após ter selecionado a pasta code irá executar o comando :

git clone  + o link copiado

Pronto o projeto já está no seu ambiente local, para edita-lo basta abrir com o vscode, ou algum editar de texto de sua preferência!

Subindo o Docusaurus localmente.

Antes de subir, por ter clonado o projeto no passo acima, será necessário iniciar outro docusaurus, porém será um processo bem simples e rapido, você ira criar uma pasta em um local de sua preferência (para facilitar o acesso recomendamos a sua area de trabalho), e com o cmd em modo administrador você vai selecionar ela, e executar o comando:

docusaurus-init

Com isso ele irá criar um projeto do docusaurus inicial, dito isso, após a instalação do docusaurus padrão da plataforma você vai na pasta website e selecionar node_modules e copiar pra pasta do seu repositório code/Docusaurus/website que você instalou mais acima clonando do azure, pois no azure não há essa pasta que é necessário para você poder subir localmente o docusaurus, lá vai ter todas as depêndencias necessárias para a execução do servidor localmente do docusaurus, após ter copiado os arquivos você vai selecionar através do cmd a pasta website do projeto original do grupo barcelos e executar o comando:

npm run start

Pronto o projeto estará rodando localmente na sua máquina e o site irá se abrir sozinho no seu navegador padrão, caso não abra, só acessar: http://localhost:3000

Após isso, você já está com o projeto que foi clonado rodando em sua máquina, pode excluir o projeto padrão criado anteriormente.

Criando documentos

Para criar documentos é bem simples você vai e criar na pasta Docs o arquivo da seguinte forma: nome Do arquivo ".md", dentro do arquivo o primeiro trecho a ser escrito é:

---
id: nome do documento
title: titulo do documento
sidebar_label: nome do documento na barra lateral da documentação
---

e após isso entrar no sidebars.js para adiocionar o documento criado na página Docs do site. E após isso é só começar a documentar

Detalhes adicionais na criação de documentos

Para criar um menu navegavel no própio documento utiliza-se "##" antes de cada "titulo" de uma nova seção do documento. Se for necessário mostrar um trecho de código destacado utiliza-se o: "```" Seu código aqui!

"```" Um exemplo:

const doc = "docusaurus"

Testando o documento criado

dentro da pasta website executar o comando:

npm run build

e após a execução do comando acima, executar:

npm run start

pronto irá abrir a página no ambiente local automaticamente, e você vera o seu documento criado na página Docs.

Subindo para produção

Para subir para produção é um processo bem simples, após ter criado e testado os documento, você vai subir para a sua branch, e passar pelas branch de homologação, de homologação para master e de master pra stable, feito esse procedimento e não havendo nenhum conflito, você vai acessar pelo acesso remoto do windows o servidor 192.168.0.243, e logar no usuário de Desenvolvedor, o usuário e a senha você encontra no link Cofre de Senhas, na página de suporte sistema, na opção Usuário Desenvolvimento servidor 243, lembrando que para acessar o cofre, precisa estar dentro da rede do grupo barcelos ou na vpn. Após ter acessado o usuário de desenvolvimento, você deverá abrir o git bash executar os comandos:

cd code/Docusaurus
git pull origin stable

e depois disso acessar via cmd (lembrando de abrir o cmd como administrador) a pasta code/Docusaurus/website e executar o seguinte comando:

npm run build

Pronto seu documento já está em produção! só acessar a página http://docusaurus.grupobarcelos.com.br