merge doxygen docs to neovim.org repo

[justinmk]

Assuming @stefan991 has interest in this, I think we should consider either linking to the doxygen docs at http://neovim.menkar.uberspace.de/devdoc or actually having his script push the latest build to this repo and hosting them on neovim.github.io.

It should be possible to modify the doxygen CSS to match the neovim branding, but it might be a pain. I know it's important to maintain a consistent look, but it's also important to provide a central channel for users in search of project materials. At the moment we're a bit scattered.

[stefan991]

@justinmk Im not sure about pushing the builded docs to Github. If we do this this should get its own repo which can be hosted as a subdir on neovim.github.io (e.g. neovim.github.io/devdoc).

The easiest solution would be to point a subdomain (e.g. devdoc.neovim.org) to my server.

Updating the doxygen css is definitely on my todo list :)

[justinmk]

neovim/neovim#824 looks fabulous! We need to link to it as soon as we figure out the layout adjustments for neovim.org.

[jdavis]

So I did a bit of sleuthing and we could actually automate the entire thing and still host the dev-docs using GitHub Pages. Here are two interesting links:

• http://philipuren.com/serendipity/index.php?/archives/21-Using-Travis-to-automatically-publish-documentation.html
• http://wesleyhales.com/blog/2013/03/29/Fun-with-Static-Site-Generators-and-Travis/

And unless I'm reading it incorrectly, we should be able to generate the documentation on Travis and then we could push it to a gh-pages branch. Everything would be automated and yet not rely on any other servers than what we already have.

Does that look do-able? Would we want to do that in this case?

[justinmk]

I'm not sure but I'm guessing @stefan991 is hesitant to push mega-uploads to the main site repo in case it causes some issue on neovim.org?

Note also we have clang analysis report now: neovim/neovim#167 (comment)

It's ~90 MB, we have 1 GB on github.io.

[jdavis]

Ah, gotcha. Okay, that's totally fine in that regard. How do we want to add them to the site then?

[stefan991]

I'm not sure but I'm guessing @stefan991 is hesitant to push mega-uploads to the main site repo in case it causes some issue on neovim.org?

At least it would clutter the history of the main site.
If we put the builded docs into its own repo we could delete the old history once 1GB gets filled up.

Does that look do-able? Would we want to do that in this case?

This should be do-able. The linked posts describe pretty well what we need to do.
We could create a github bot account like the one from rust (bors) which could do the pushes from travis to a new documentation repo. @jdavis could ask the community to come up with a good name :)

[jdavis]

Haha, k. I'll ask.

Also, I think a separate bot account + a different repo is preferable like you mentioned. It keeps the history of the docs and website separate.

Edit: Actually, I'll ask if @justinmk thinks it would be a good idea to separate it into its own repo + a bot GitHub account.

[justinmk]

If we put the builded docs into its own repo we could delete the old history once 1GB gets filled up.

Yeah, or we could just git commit --amend && git push -f every time.

I'll ask if @justinmk thinks it would be a good idea to separate it into its own repo + a bot GitHub account.

👍

[jdavis]

That's a great idea.

[jdavis]

@stefan991 Since Justin approves, should I ask on Twitter about a name for the Neovim GitHub bot? I imagine it could be useful in multiple ways beyond just this development documentation.

Also, have you made any progress on it?

[stefan991]

Since Justin approves, should I ask on Twitter about a name for the Neovim GitHub bot?

👍

Also, have you made any progress on it?

No I haven't started yet, but it's the next item on the todo list :)

[jdavis]

K cool.

I asked here, I have a feeling we'll have some interesting responses: https://twitter.com/Neovim/status/478947139473911808

[stefan991]

@jdavis travis documentation generation is working:

commit on my branch: stefan991/neovim@1c7ac92
output repo: https://github.com/stefan991/documentation_test
hosted documentation on github: http://stefan991.github.io/documentation_test/index.html

This is based on neovim/neovim#824. After this PR gets merged I can adjust this to work with the bot/repo on the Neovim organization.

[jdavis]

Awesome. That looks great.

Now to wait on neovim/neovim#824 like you said.

Did you see any names that you liked for the bot? I thought Marvim was the best and cleverest so far, haha.