Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Render files with .md extension in markdown format #71

Open
arosales opened this issue Mar 28, 2015 · 1 comment
Open

Render files with .md extension in markdown format #71

arosales opened this issue Mar 28, 2015 · 1 comment
Milestone

Comments

@arosales
Copy link

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

@mitechie
Copy link
Contributor

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.

@frankban frankban added this to the Future milestone May 20, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants