Home
Documentation
Sensedia Docs Guia de uso
Setup and Publish Documentation

Setup and Publish Documentation

Learn how to publish documentation using Sensedia Docs.

Sensedia Docs provides a streamlined process for publishing documentation.

📋 Table of Contents

Introduction
Setting Up Your Project
Creating Documentation
Publishing Your Documentation
FAQ

Introduction

Publishing documentation is a crucial step in the documentation lifecycle. Sensedia Docs offers a variety of tools and features to help you publish your documentation efficiently and effectively. In this guide, we will walk you through the process of publishing your documentation using Sensedia Docs.

Setting Up Your Project

Before you can publish your documentation, you need to set up your project. This involves creating a new project in Sensedia Docs and configuring it to suit your needs.

Steps to Set Up Your Project

Clone the Repository

Start by cloning the Sensedia Docs repository to your local machine.

Copy the example Project

Inside the cloned repository, you will find an example directory. This directory contains a sample project that you can use as a starting point for your documentation.

Install Dependencies

Navigate to your project directory and install the necessary dependencies.

Configure Your Project

Open the bitbucket-pipelines.yml file and configure it according to your project's requirements. This file defines the publishing pipeline and specifies how your documentation will be deployed.

Set Up Environment Variables

Ensure that your Bitbucket repository is set up correctly to trigger the pipeline when changes are pushed. This includes setting up environment variables STRAPI_URL, STRAPI_TOKEN.

You need to access Strapi to generate these tokens, which are used to authenticate and authorize your documentation updates.

Go to your Strapi admin panel.
Navigate to Settings > API Tokens.
Create a new token with the necessary permissions for your documentation.
Copy the generated token and set it as an environment variable in your Bitbucket repository settings.

Creating Documentation

Once your project is set up, you can start creating your documentation. Sensedia Docs provides a user-friendly interface for authoring and organizing your content. You can create different types of documents, such as guides, API references, and tutorials, using Markdown + visualizer (Sensedia Docs VSCode Extension).

Publishing Your Documentation

The publishing process is managed by Bitbucket Pipelines, which automatically builds and deploys your documentation when you push changes to the repository. The pipeline defined in the bitbucket-pipelines.yml file will handle the build and deployment process.

FAQ

How happy are you with this page?

Writing Documentation

Assets and files