Workshop: DIY Documentation Portal
-
-
1h 30 min
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:
- Create our first portal using the Markdown language and the MkDocs engine.
- Plug in the popular Material theme and customize the portal: repaint it in corporate colours, replace the logo, plug in various plugins and extensions.
- Put the entire result of our work on Git.
- Using GitHub Actions, we will configure the deployment of our portal to GitHub Pages and automate the posting of updates.
Before the master class:
- Create an account on GitHub.
- Install Git: git-scm.com/download
- Install Python: www.python.org/downloads