Skip to main content

How to Export MATE Pipeline Documentation

There is usually a Generate Docs step when running a DataOps pipeline that includes MATE jobs. This documentation is available directly from the pipeline view for the last successful pipeline run for a given environment:

pipeline view with documentation and download button !!shadow!!

In specific scenarios, you might need to export and archive the documentation by downloading it to fulfill audit requirements.

download MATE documentation from pipeline view !!shadow!!

You can back up the resultant archive to your preferred archive system. After restoration, serve the documentation by running it off a web server. To do so, follow these steps:

  1. Extract the to a folder called $HOME/docs.
  2. Change your working directory to $HOME/docs/dataops/modelling/target/.
  3. Run a standalone web server with this directory as root, e.g., python3 -m http.server 8080.
  4. Point your browser to http://localhost:8080/.

browsing MATE documentation offline !!shadow!!