Move the blogofile docs

50 views
Skip to first unread message

Doug Latornell

unread,
May 30, 2012, 4:08:54 PM5/30/12
to blogofil...@googlegroups.com
I would like to suggest that we move the blogofile docs from the blogofile.com repo [1] to the blogofile core repo [2]. I guess this is mostly a matter of personal preference for me. I think that having them in the same repo as the code will help them to stay in sync with the code. It allows changes to code and related docs changes to be in the same commit, when appropriate. It will also make for a cleaner release process, and easier integration into a service like travis-ci.org if we want to do that down the road.

In conjunction with changing the repo location, I would also like to put the docs on readthedocs.org. We can take advantage of their multi-version feature to keep the 0.7 docs available while the 0.8 docs evolve. Ryan, if you have access to the CNAME record in your DNS for blogofile.com the docs can be hosted on readthedocs.org but continue to appear as they do now within blogofile.com [3].

[1] https://github.com/EnigmaCurry/blogofile.com
[2] https://github.com/EnigmaCurry/blogofile
[3] http://readthedocs.org/docs/read-the-docs/en/latest/alternate_domains.html

Mike Pirnat

unread,
May 30, 2012, 6:07:17 PM5/30/12
to blogofil...@googlegroups.com
+1 on both points. +even more on the docs-with-code point if bonus
rounds of voting are allowed. :-)

Sorry I am not offering much beyond cheerleading and pom-pom waving,
but I want to make sure you know there's support for these ideas.

--
Mike Pirnat
mpi...@gmail.com
http://mike.pirnat.com/

Ryan McGuire

unread,
May 30, 2012, 6:29:53 PM5/30/12
to blogofil...@googlegroups.com
I can create a CNAME for sure, let me know where to point it to.


--
You received this message because you are subscribed to the Google Groups "blogofile-discuss" group.
To post to this group, send email to blogofil...@googlegroups.com.
To unsubscribe from this group, send email to blogofile-disc...@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/blogofile-discuss?hl=en.


Doug Latornell

unread,
May 30, 2012, 9:25:22 PM5/30/12
to blogofil...@googlegroups.com
On Wed, May 30, 2012 at 3:07 PM, Mike Pirnat <mpi...@gmail.com> wrote:
> +1 on both points.  +even more on the docs-with-code point if bonus
> rounds of voting are allowed. :-)
>
> Sorry I am not offering much beyond cheerleading and pom-pom waving,
> but I want to make sure you know there's support for these ideas.

The +1s are welcome, Mike. Helps me confirm that I'm making sense.

As for other stuff... your time will come... bwahahahaha! :-)

Doug

Doug Latornell

unread,
May 30, 2012, 9:26:12 PM5/30/12
to blogofil...@googlegroups.com
On Wed, May 30, 2012 at 3:29 PM, Ryan McGuire <tell...@gmail.com> wrote:
> I can create a CNAME for sure, let me know where to point it to.

Great, Ryan! I'll let you know when I have the rtd hosting working.

Doug Latornell

unread,
Jun 23, 2012, 1:19:50 PM6/23/12
to blogofil...@googlegroups.com

I've got the 0.7.1 and the latest/plugins docs building on RTD: http://blogofile.readthedocs.org/

Ryan, can you please activate the ReadTheDocs service hook in the github repo as described here:
http://read-the-docs.readthedocs.org/en/latest/webhooks.html#github

A CNAME record pointed at blogofile.readthedocs.org should now resolve to the latest update of the docs. I'm not sure how you want to integrate that into blogofile.com/documentation - perhaps a redirect to docs.blogofile.com with that subdomain named in the CNAME record?

I've also noticed that the github commits sidebar on the blogofile.com site isn't showing the recent commits I pushed to put the 0.7.1 docs in master. If you know why and can resolve that easily, Ryan, I'd appreciate it. Even better would be if that sidebar could reflect the plugins branch (at least until it is merged) so that current dev activity is evident.

Thanks...

Ryan McGuire

unread,
Jun 24, 2012, 2:02:28 PM6/24/12
to blogofil...@googlegroups.com
Should be all setup.

The sidebar also now shows commits in both branches.

--
You received this message because you are subscribed to the Google Groups "blogofile-discuss" group.
To view this discussion on the web visit https://groups.google.com/d/msg/blogofile-discuss/-/f9JYqRuyYTMJ.

Doug Latornell

unread,
Jun 25, 2012, 10:06:15 PM6/25/12
to blogofil...@googlegroups.com
On Sun, Jun 24, 2012 at 11:02 AM, Ryan McGuire <ry...@enigmacurry.com> wrote:
> Should be all setup.
>
> The sidebar also now shows commits in both branches.

Yep, looks like it's all working the way it should.

Thanks, Ryan!
Reply all
Reply to author
Forward
0 new messages