machinekit / machinetalk-protobuf

Protobuf declarations for machinekit messages
MIT License
10 stars 11 forks source link

Amend asciidoc.mustache #80

Closed ArcEye closed 7 years ago

ArcEye commented 7 years ago

Match the pre-header of asciidoc.mustache to that used in machinekit-docs/scripts/machinekit.mustache. Jekyll is currently ignoring the protobuf.asciidoc generated from this repo when rendering the website.

ArcEye commented 7 years ago

When in, I will comment out my hack in Jenkins and force a rebuild to see if Jekyll now renders the document correctly.

ArcEye commented 7 years ago

Success !!!! That was the problem.

For quite some while the machinetalk-protobuf repo remained the same as the copy in machinekit-docs, so the protobuf.asciidoc generated from the machinekit-docs.mustache formatting template within machinekit-docs was used.

When machinetalk-protobuf was updated, the generation was from the asciidoc.mustache within that repo, which lacked the pre-header inserted thus

---
layout: docs
---

This triggers Jekll to generate a container directory of the same name as the file and and index.html file within it with the data, allowing reference by just the name eg. http://machinekit.io/docs/machinetalk/protobuf

This PR will be linked to an issue in machinekit-docs, so we don't forget when it occurs again :smile: