-
Notifications
You must be signed in to change notification settings - Fork 20
Added module documentation visualization and fixed haml top bar. Added "--modulepath" option to the library. #10
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
base: master
Are you sure you want to change the base?
Conversation
@@ -41,6 +41,7 @@ Gem::Specification.new do |spec| | |||
spec.add_dependency "haml" | |||
spec.add_dependency "docile", ">= 1.0.0" | |||
spec.add_dependency "open4" | |||
spec.add_dependency "redcarpet" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This breaks compatibility with Ruby 1.8.7, maybe try "~> 2.3.0".
Thanks @Moliholy, this looks like a good idea. I'd be willing to merge it if you address the comments I made, and if the build passes. At the moment, there are some failing tests for the UI changes, and there are errors on Ruby 1.8.7 from Redcarpet. |
Done, it should work out now. |
@@ -24,6 +24,12 @@ | |||
$(document).ready(function() { | |||
var source = "modules.json#{ query.nil? ? '' : '?q=' + query }"; | |||
$.getJSON(source, function(modules) { | |||
modules.sort(function(a, b){ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It sorts all modules by full name. I tried to do it in the server but because of problems with ruby versions it ended up being a pain in the neck, so it's finally the client who is going to do it.
After some time trying to figure out the reason the build did not pass, I finally ended up finding the solution: there is no README.md file on the tests, so an exception was raised when trying to read the compressed file. Now of course this has been solved. Aside from that, I have included a new option called "--modulepath" that, in a nutshell, includes a directory with directly the modules' source, instead of strictly a packed format. And, finally, links to directly download packed modules depending on the version. Best regards, |
@@ -22,4 +22,9 @@ | |||
%div= "Versions:" | |||
%ul | |||
- metadata["releases"].each do |release| | |||
%li= release["version"] | |||
%li | |||
%a{:href => "/modules/#{metadata["author"]}-#{metadata["name"]}-#{release["version"]}.tar.gz"} #{release["version"]} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It creates a link to download the packed modules in the version number.
…odule. Changed markdawn parser to allow anchors
Conflicts: lib/puppet_library/forge/abstract.rb
Hello,
in order to have a better visualization of the module in the web page I have added the README.md or README.markdown files included in the own compressed module, and parsed to html using redcarpet library (https://github.com/vmg/redcarpet) to be conveniently shown.
I have also fixed some issues with the top bar, which didn't correctly show the title of the modules.
Best regards,
José Molina Colmenero