[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
[elk-dev] generating melk documentation
|
Hi everyone,
I'm working on generating documentation about the algorithms and options
declared in *.melk files automatically. The plan here is to have a
'MelkDocumentationGenerator' write the content to markdown files which
are then either pushed to a designated github repository or into the
gh-pages branch of the elk repo. With a few configuration files we can
coax github into running a static-site-generator (jekyll) that crawls
the markdown files and creates a website.
The ELK Wiki will be migrated as well to have everything in the same place.
The generator will be executed when the project is built, so this
shouldn't affect anyone's workflow.
To expand the means of documentation the ELK metadata language already
supports a 'documentation' attribute that wasn't used thus far but would
come in handy for referring to an additional markdown file.
In case you have suggestions regarding the documentation I created an
issue: https://github.com/eclipse/elk/issues/91
Best,
dag
