On Wed, Mar 25, 2015 at 11:07:34AM +0800, Gris Ge wrote: > Let me create one more demo for keeping doc in existing git repo. > It will be located at: > http://cathay4t.github.io/libstoragemgmt Done. I also did some small tweaks. https://github.com/cathay4t/libstoragemgmt/tree/gh-pages
I also found some concerns about keeping git pages files in existing
git tree:
1. How we handle document update pull request?
# Initially, there will be a lot document update, do we really
# need to FPM("fork -> pull request -> merge") workflow?
# Or maybe, let me do it in my repo(git commit --amend).
# Once everyone satisfied, we push it to upstream.
# After that, we do FPM workflow on future changes.
2. How we maintain 'master' branch and 'gh-pages'[1] branch.
# Keep every thing in 'master' branch and sync it with
# 'gh-pages' branch?
[1] 'gh-pages' branch is mandatory for github pages.
> >
> > I stubbed out some wiki pages and I was actually thinking that instead
> > of using a TOC, if each topic was placed on it's own page a person could
> > use the sidebar instead of a TOC for navigation.
> >
> > see: https://github.com/libstorage/libstoragemgmt/wiki
> >
> For API document, you cannot break it into 20+ pages. We still need to
> TOC or TOC-like sidebar.
>
> I manual(and some short perl script) created some TOC, please check
> these examples:
> http://cathay4t.github.io/libstoragemgmt-doc/doc/py_api_user_guide.html
> http://cathay4t.github.io/libstoragemgmt-doc/doc/install.html
> http://cathay4t.github.io/libstoragemgmt-doc/doc/user_guide.html
Please try these pages instead :
http://cathay4t.github.io/libstoragemgmt/doc/markdown/py_api_user_guide.html
http://cathay4t.github.io/libstoragemgmt/doc/markdown/install.html
http://cathay4t.github.io/libstoragemgmt/doc/markdown/user_guide.html
> ------------------------------------------------------------------------------
> Dive into the World of Parallel Programming The Go Parallel Website, sponsored
> by Intel and developed in partnership with Slashdot Media, is your hub for all
> things parallel software development, from weekly thought leadership blogs to
> news, videos, case studies, tutorials and more. Take a look and join the
> conversation now. http://goparallel.sourceforge.net/
> _______________________________________________
> Libstoragemgmt-devel mailing list
> Libstoragemgmt-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/libstoragemgmt-devel
--
Gris Ge
signature.asc
Description: Digital signature
------------------------------------------------------------------------------ Dive into the World of Parallel Programming The Go Parallel Website, sponsored by Intel and developed in partnership with Slashdot Media, is your hub for all things parallel software development, from weekly thought leadership blogs to news, videos, case studies, tutorials and more. Take a look and join the conversation now. http://goparallel.sourceforge.net/
_______________________________________________ Libstoragemgmt-devel mailing list Libstoragemgmt-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/libstoragemgmt-devel
