dojo-modeling / dojo-docs

Dojo Documentation

This is a Jekyll App using the Just the Docs theme. It is hosted with Github Pages.

Running Locally

If you want to contribute to the documentation, the easiest way to do so is to run the Jekyll app locally. You can run it by pulling down the project, installing Jekyll, and running

• bundle install to install dependencies
• bundle exec jekyll start -l to run the server

Adding New Pages

New top level pages go in docs. Child pages go in docs/details. Any new pages need to be added to the navigation structure in docs/_data/navigation.yml in order to show up in the sidebar. This is then rendered by docs/_includes/components/sidebar.html, which overrides the default Just the Docs sidebar.html. This is an alternative to the Just the Docs default of adding nav_order to the front matter block, as it allows us to much more easily see and change the nav order/structure.

Make sure to add new pages to docs/_data/navigation.yml

dojo-docs's Issues

Add guide on how to convert a Jupyter Notebook to a runnable Dojo model

Investigate ability to convert an Excel spreadsheet model to an executable Python script

Potential packages that may work:

Formulas: https://github.com/vinci1it2000/formulas

xlcalculator: https://github.com/bradbase/xlcalculator

pycel: https://github.com/dgorissen/pycel

Reference:

Excel formula parsing in multiple languages including Python:
https://ewbi.blogs.com/develops/popular/excelformulaparsing.html

Update documentation

Things needed to improve/complete documentation:

• Include link to Github page (https://github.com/dojo-modeling/dojo)
• Remove links to youtube as these are out of date, replace, if possible, with 1-3 screenshots of the current flow
• Add references/links to dojo-cli. (https://github.com/dojo-modeling/dojo-cli)
• Remove references to /run api endpoints for execution as DMC is not part of dojo stack. replace /run/DMC references with dojo-cli documentation
• Cheatsheet (https://docs.dojo-test.com/cheatsheet.html) needs to be updated to provide info on using the cli tool inside the containers (from upcoming provisioning work).

Deploy updated documentation to dojo-modeling.com

https://dojo-modeling.com/ should point to index.md via the normal github docs framework.