Workshop: DIY Documentation Portal

  • 1h 30 min

I am from the VK WorkSpace team of technical writers and one of the authors of the documentation portal:

I'll tell you how any technical writer can switch to the docs-as-code approach and launch a web portal with documentation without the help of dev-ops and developers. We will go the following way:

  1. Create our first portal using the Markdown language and the MkDocs engine. 
  2. Plug in the popular Material theme and customize the portal: repaint it in corporate colours, replace the logo, plug in various plugins and extensions. 
  3. Put the entire result of our work on Git. 
  4. Using GitHub Actions, we will configure the deployment of our portal to GitHub Pages and automate the posting of updates. 

Optionally, I will explain how to use Docker to connect our GitLab Runners so that point 4 will work if you use GitLab.

Before the master class: 

  1. Create an account on GitHub. 
  2. Install Git: 
  3. Install Python:

Comments ({{Comments.length}} )
  • {{comment.AuthorFullName}}
    {{ comment.DateCreated | date: 'dd.MM.yyyy' }}

To leave a feedback you need to

Chat with us, we are online!