You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
For projects we are working on feedback we have received is to make developer documentation. Specifically, the specification on how the charm was developed is useful to other developers looking to contribute to the charms and bundles.
To address that feedback we have made files such as DEV-README.md that contains developer specific documentation.
Thanks for the issue @arosales. We don't currently parse any content and just show the files straight from the charmstore to users other than the readme. The rest are served raw so they can be copied/pasted/etc. We'll investigate what it would take and what the trade off would be to start serving more files from there. Even the readme file is in raw form when you click on it from the file explorer.
I understand the need for the documentation though and agree pretty docs > raw markdown docs.
For projects we are working on feedback we have received is to make developer documentation. Specifically, the specification on how the charm was developed is useful to other developers looking to contribute to the charms and bundles.
To address that feedback we have made files such as DEV-README.md that contains developer specific documentation.
One example of this is:
https://jujucharms.com/u/bigdata-dev/apache-hadoop-hdfs-master/
-in this charm there is a file named DEV-README.md in the root directory.
When a developer clicks on this file it produces the raw (un-rendered) markdown.
https://api.jujucharms.com/charmstore/v4/~bigdata-dev/trusty/apache-hadoop-hdfs-master-41/archive/DEV-README.md
Thus bug is request that for files ending in an .md extension the GUI renders the markdown version of that file.
-thanks,
Antonio
The text was updated successfully, but these errors were encountered: