O Sensedia Docs oferece um processo simplificado para publicação de documentação.
Publicar documentação é uma etapa crucial no ciclo de vida da documentação. O Sensedia Docs oferece diversas ferramentas e recursos para ajudar você a publicar sua documentação de forma eficiente e eficaz. Neste guia, vamos mostrar o processo de publicação usando o Sensedia Docs.
Antes de publicar sua documentação, é necessário configurar seu projeto. Isso envolve criar um novo projeto no Sensedia Docs e ajustá-lo conforme suas necessidades.
Dentro do repositório clonado, você encontrará um diretório example. Este diretório contém um projeto de exemplo que pode ser usado como ponto de partida para sua documentação.
Navegue até o diretório do seu projeto e instale as dependências necessárias.
Abra o arquivo bitbucket-pipelines.yml e configure-o de acordo com os requisitos do seu projeto. Este arquivo define o pipeline de publicação e especifica como sua documentação será implantada.
Certifique-se de que seu repositório Bitbucket está configurado corretamente para acionar o pipeline quando alterações forem enviadas. Isso inclui configurar as variáveis de ambiente STRAPI_URL e STRAPI_TOKEN.
Você precisa acessar o Strapi para gerar esses tokens, que são usados para autenticar e autorizar as atualizações da sua documentação.
Com o projeto configurado, você pode começar a criar sua documentação. O Sensedia Docs oferece uma interface amigável para criação e organização do conteúdo. É possível criar diferentes tipos de documentos, como guias, referências de API e tutoriais, usando Markdown + visualizador (Extensão Sensedia Docs para VSCode).
O processo de publicação é gerenciado pelo Bitbucket Pipelines, que constrói e publica sua documentação automaticamente quando você envia alterações para o repositório. O pipeline definido no arquivo bitbucket-pipelines.yml cuidará do processo de build e deploy.
O pipeline é acionado automaticamente quando você envia alterações para o repositório. Certifique-se de que seu arquivo bitbucket-pipelines.yml está corretamente configurado para o branch main.
Verifique se você enviou as alterações para o branch correto e se o pipeline foi concluído com sucesso. Consulte os logs do pipeline para identificar possíveis erros.
Basta fazer alterações nos arquivos Markdown e enviá-las para o repositório. O pipeline irá reconstruir e republicar sua documentação automaticamente.
Nosso site utiliza cookies para habilitar funcionalidades essenciais de avaliação e notificações. Não utilizamos cookies de rastreamento para publicidade ou análise de terceiros.Saiba mais