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

Markdown syntax in docs/adapters.md preventing update of hubot.github.com #1100

Closed
technicalpickles opened this issue Dec 17, 2015 · 2 comments

Comments

@technicalpickles
Copy link
Member

We do some magic in the (private) hubot.github.com repo to use this repository as a submodule to get up to date documents. Something about docs/adapter.md is making it unhappy:

The page build failed with the following error:

The file `_submodules/hubot/docs/adapters.md` contains syntax errors. For more information, see https://help.github.com/articles/page-build-failed-markdown-errors.

If you have any questions you can contact us by replying to this email.

I don't see anything obvious wrong. We're using html-pipeline for markdown, so I don't think we can just switch to kramdown. Also, I tried that, and it didn't catch any errors in development...

@technicalpickles
Copy link
Member Author

Kramdown doesn't find it:

irb(main):004:0> Kramdown::Document.new(File.read('docs/adapters.md')).to_html
=> "<hr />\n<p>permalink: /docs/adapters/index.html\nlayout: docs\n—</p>\n\n<p>Adapters are the interface to the service you want your hubot to run on.</p>\n\n<h2 id=\"official-adapters\">Official Adapters</h2>\n\n<p>Hubot includes two official adapters:</p>\n\n<ul>\n  <li><a href=\"/docs/adapters/shell.md\">Shell</a>, i.e. for use with development</li>\n  <li><a href=\"/docs/adapters/campfire.md\">Campfire</a></li>\n</ul>\n\n<h2 id=\"third-party-adapters\">Third-party Adapters</h2>\n\n<p>Third-party adapters are available as <code>npm</code> packages. Here is a list of known\nadapters, but please <a href=\"https://github.com/github/hubot/issues\">submit an issue</a>\nto have yours added to the list:</p>\n\n<ul>\n  <li>\n    <p><a href=\"https://github.com/Hammertime38/hubot-proxy\">Proxy</a> - This adapter allows the base application to observe, handle, and control events sent to the proxied adapter, all defined in a config object at the root of the module.</p>\n  </li>\n  <li><a href=\"https://github.com/shaundubuque/hubot-aim\">AIM</a></li>\n  <li><a href=\"https://github.com/akiomik/hubot-chatwork\">ChatWork</a></li>\n  <li><a href=\"https://github.com/nebulist/hubot-dasher\">Dasher</a></li>\n  <li><a href=\"https://github.com/anroots/hubot-fleep\">Fleep</a></li>\n  <li><a href=\"https://github.com/flowdock/hubot-flowdock\">Flowdock</a></li>\n  <li><a href=\"https://github.com/huafu/hubot-gitter2\">Gitter</a></li>\n  <li><a href=\"https://github.com/atmos/hubot-gtalk\">Gtalk</a></li>\n  <li><a href=\"https://github.com/Hall/hubot-hall\">Hall</a></li>\n  <li><a href=\"https://github.com/hipchat/hubot-hipchat\">HipChat</a></li>\n  <li><a href=\"https://github.com/lazerwalker/hubot-imessage\">iMessage</a></li>\n  <li><a href=\"https://github.com/nandub/hubot-irc\">IRC</a></li>\n  <li><a href=\"https://github.com/smoak/hubot-jabbr\">Jabbr</a></li>\n  <li><a href=\"https://github.com/sdelements/hubot-lets-chat\">Let’s Chat</a></li>\n  <li><a href=\"https://github.com/miyagawa/hubot-lingr\">Lingr</a></li>\n  <li><a href=\"https://github.com/xhan/qqbot\">QQ</a></li>\n  <li><a href=\"https://github.com/iangreenleaf/hubot-partychat-hooks\">Partychat</a></li>\n  <li><a href=\"https://github.com/RocketChat/hubot-rocketchat\">Rocket.Chat</a></li>\n  <li><a href=\"https://github.com/slackhq/hubot-slack\">Slack</a></li>\n  <li><a href=\"https://github.com/netpro2k/hubot-skype\">Skype</a></li>\n  <li><a href=\"https://github.com/sdimkov/hubot-skype-web\">SkypeWeb</a></li>\n  <li><a href=\"https://github.com/unixcharles/hubot-talker\">Talker</a></li>\n  <li><a href=\"https://github.com/lukefx/hubot-telegram\">Telegram</a></li>\n  <li><a href=\"https://github.com/jkarmel/hubot-twilio\">Twilio</a></li>\n  <li><a href=\"https://github.com/MathildeLemee/hubot-twitter\">Twitter</a></li>\n  <li><a href=\"https://github.com/nulab/hubot-typetalk\">Typetalk</a></li>\n  <li><a href=\"https://github.com/victorops/hubot-victorops\">VictorOps</a></li>\n  <li><a href=\"https://github.com/scrumdod/hubot-VSOnline\">Visual Studio Online</a></li>\n  <li><a href=\"https://github.com/markstory/hubot-xmpp\">XMPP</a></li>\n  <li><a href=\"https://github.com/athieriot/hubot-yammer\">Yammer</a></li>\n</ul>\n\n<h2 id=\"writing-your-own-adapter\">Writing Your Own Adapter</h2>\n\n<p>Interested in adding your own adapter? Check out our documentation for <a href=\"/docs/adapters/development.md\">developing adapters</a></p>\n"

@technicalpickles
Copy link
Member Author

This has been fixed ✨

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

1 participant