[GitHub] [incubator-streampipes-website] dominikriemer commented on pull request #16: Fix broken links on Streampipes documentation

[GitBox <gi...@apache.org>]

dominikriemer commented on pull request #16:
URL: https://github.com/apache/incubator-streampipes-website/pull/16#issuecomment-836965209


   Sure, happy to help!
   This is a rather quick-and-dirty plugin I typically run once after each release, so there might be bugs, but the general process is somehow semi-automatic ;-)
   
   - add the streampipes-maven-plugin to the extensions project
   - execute mvn streampipes:extract-docs
   - this generates docs for the website & docusaurus pages and rewrites the image paths of the icons mentioned in the markdown files.
   - I manually copy the markdown files in target\docs\docs-documentation\pe into the documentation/docs/pe folder of streampipes-website 
   - I copy the content of target/docs/sidebars.json into the sidebars.json of the docs repo (after the updates of the documentation structure, this part of the script produces an incorrect output and needs to be changed so that the list is ordered by pipeline element type)
   - Images are manually copied from the img folder to the corresponding Docusaurus folder.
   - The updated docs are then available for the "next" version in Docusaurus
   
   I assume you already successfully generated the docs and maybe just ran into the issue with the sidebars.json or which kind of inconsistencies did find?
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org