isobar-us / code-standards

Isobar Front-end development coding standards. Memorize them BY HEART.

Home Page:https://isobar-us.github.io/code-standards/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Use Google Docs to author the content and convert to Markdown

jaredwilli opened this issue · comments

Hey,

So I've been recently working a lot with Addy and Paul et al Chrome team to update the Chrome DevTools Docs, and the way we are doing things is using Google Docs to author and collaborate on the documents, and then convert the gdoc to Markdown. Well, that's not quite how we've been doing it, but it will be more so now that they told me about https://github.com/mangini/gdocs2md.

Since the standards doc was being moved to markdown, and since writing in google docs is so easy and better for collab reasons, this would be a good idea for you guys to look at, and maybe adopt.

Just wanted to make that suggestion.

PS: I work a block away from South Station now for those who don't know, at Brightcove. 📹 📼 We should have lunch sometime :)

Hey @jaredwilli - it's not a bad concept in and of itself... but I think we have too many steps and hurdles in the process already. We're working on trying to get the grunt.js bit working and the content edits are critical after that. The notion of adding a converter needed manually ... not so appealing to me at least. Not that I'm the final word.

The fact that Github does markdown editing right in the web UI is quite appealing. Immediate commits, etc.

Unless anyone objects I'll probably close this in a few days.

Thanks though!

And congrats on the new gig! Maybe you can help solve some Brightcove issues we're having LOL ;-)

If we could automate this process it would be great, but until we can I think we should stick with plain markdown. I agree we don't want to complicate our build process further.

I don't think we're going to be using Google Docs anytime soon.