Jira (PDOC-150) README links broken after being HTMLfied

2018-04-12 Thread Eric Putnam (JIRA)
Title: Message Title


 
 
 
 

 
 
 

 
   
 Eric Putnam commented on  PDOC-150  
 

  
 
 
 
 

 
 
  
 
 
 
 

 
  Re: README links broken after being HTMLfied   
 

  
 
 
 
 

 
 David Hollinger This is still an issue, though not necessarily a bug. We would need puppet-strings to start pulling in other markdown files or link out to github for things like CONTRIBUTING or MAINTAINERS, etc. Thoughts there? If someone is viewing the strings documentation, would they also want to see the contributing docs? Or would that be someone who is already on the github ui?  
 

  
 
 
 
 

 
 
 

 
 
 Add Comment  
 

  
 

  
 
 
 
  
 

  
 
 
 
 

 
 This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93)  
 
 

 
   
 

  
 

  
 

   





-- 
You received this message because you are subscribed to the Google Groups "Puppet Bugs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com.
To post to this group, send email to puppet-bugs@googlegroups.com.
Visit this group at https://groups.google.com/group/puppet-bugs.
For more options, visit https://groups.google.com/d/optout.


Jira (PDOC-150) README links broken after being HTMLfied

2016-12-12 Thread David Hollinger III (JIRA)
Title: Message Title
 
 
 
 
 
 
 
 
 
 
  
 
 David Hollinger III commented on  PDOC-150 
 
 
 
 
 
 
 
 
 
 

 
 
 
 
 
 
 
  Re: README links broken after being HTMLfied  
 
 
 
 
 
 
 
 
 
 
That is definitely very similar, if not the same, issue I'm seeing with the README markdown not being properly parsed/processed into HTML. 
I can see if something is open with the redcarpet project if you haven't already created one 
 
 
 
 
 
 
 
 
 
 
 
 

 
 Add Comment 
 
 
 
 
 
 
 
 
 
 

 
 
 
 
 
 
 
 
 
 

 This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) 
 
 
 
 
  
 
 
 
 
 
 
 
 
   





-- 
You received this message because you are subscribed to the Google Groups "Puppet Bugs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com.
To post to this group, send email to puppet-bugs@googlegroups.com.
Visit this group at https://groups.google.com/group/puppet-bugs.
For more options, visit https://groups.google.com/d/optout.


Jira (PDOC-150) README links broken after being HTMLfied

2016-12-07 Thread William Hopper (JIRA)
Title: Message Title
 
 
 
 
 
 
 
 
 
 
  
 
 William Hopper commented on  PDOC-150 
 
 
 
 
 
 
 
 
 
 

 
 
 
 
 
 
 
  Re: README links broken after being HTMLfied  
 
 
 
 
 
 
 
 
 
 
David Hollinger III it sounds like you may be talking about this issue which I raised against YARD: https://github.com/lsegal/yard/issues/1032. Does that look right? 
It may be an issue with redcarpet, our markdown processing library. YARD delegates rendering markup to HTML to the markdown library. 
 
 
 
 
 
 
 
 
 
 
 
 

 
 Add Comment 
 
 
 
 
 
 
 
 
 
 

 
 
 
 
 
 
 
 
 
 

 This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) 
 
 
 
 
  
 
 
 
 
 
 
 
 
   





-- 
You received this message because you are subscribed to the Google Groups "Puppet Bugs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com.
To post to this group, send email to puppet-bugs@googlegroups.com.
Visit this group at https://groups.google.com/group/puppet-bugs.
For more options, visit https://groups.google.com/d/optout.


Jira (PDOC-150) README links broken after being HTMLfied

2016-11-29 Thread David Hollinger III (JIRA)
Title: Message Title
 
 
 
 
 
 
 
 
 
 
  
 
 David Hollinger III created an issue 
 
 
 
 
 
 
 
 
 
 

 
 
 
 
 
 
 
 Puppet Strings /  PDOC-150 
 
 
 
  README links broken after being HTMLfied  
 
 
 
 
 
 
 
 
 

Issue Type:
 
  Bug 
 
 
 

Assignee:
 

 Unassigned 
 
 
 

Created:
 

 2016/11/29 3:21 PM 
 
 
 

Priority:
 
  Normal 
 
 
 

Reporter:
 
 David Hollinger III 
 
 
 
 
 
 
 
 
 
 
When Puppet Strings turns the README.md into an HTML document, I have found that: 
 

Markdown anchors are not properly converted and don't actually go anywhere when clicked.
 

Links to other Markdown files are converted to HTML expecting the referenced files to also have been converted into yardoc HTML, however puppet-strings is only aware of the README.md, not any other markdown files in the root of the repository and as such you end up with a link to a 404 message in the finished yardoc page.
 
 
Example:  
dhollinger/autofs-puppet README references a CONTRIBUTING.md file for contribution guidelines. Puppet Strings sees that link and creates an HREF to this URL:  
https://dhollinger.github.io/autofs-puppet/CONTRIBUTING.md. 
My guess is that it sees the github flavored markdown "[CONTRIBUTING.md](CONTRIBUTING.md)" and converts that directly to the the URL seen above without validating that an HTML or Markdown file exists in that path. 
Not sure if this is an issue related to the conversion of github flavored markdown to HTML or not, but I figured it'd be easiest to start the troubleshooting process here.