If having the Github wiki populated is a desire. You could publish the mb, rst, etc docs, already being worked on given Ryan's statement, via github's wiki repo methodology. https://help.github.com/articles/adding-and-editing-wiki-pages-locally/
On Tue, Sep 26, 2017 at 5:48 PM, Dave Neuman <[email protected]> wrote: > I agree with Jan. I don't see what moving to github wiki really does for > us that cwiki can't, as a matter of fact it will probably cause other > issues like only committers can edit it. I also agree that we should have > better and more formal docs; especially ones that help new users get ATC > installed quickly. > > > > On Tue, Sep 26, 2017 at 17:10 Jan van Doorn <[email protected]> wrote: > > > I think we still need a place to document things like meet ups and the > > likes? I like the “less formal” feel of a wiki, and think the docs should > > be more “official”, and part of the release. > > > > Some people have started putting documentation in the README.md with the > > code, and while I think that’s better than no documentation, I think a > > project like ours should have official user and admin guides as part of > the > > release. We have been letting that part slip a little bit, but just > giving > > up on it seems too easy for me… > > > > So I don’t like 1. Or 1. :-) I think we should stay on the apache Cwiki > > for informal notes and beef up our rst docs for admins and users. > > > > Rgds, > > JvD > > > > > > > On Sep 26, 2017, at 2:56 PM, Durfey, Ryan <[email protected]> > > wrote: > > > > > > All, > > > > > > Given the move to Github, I think we should consider moving out of > > Apache Cwiki. While I think this is a far superior wiki to the offering > > from Github, I think unifying everything in one environment is a better > > overall approach. I also wanted to consider foregoing the wiki > altogether > > and suggest pushing this documentation into a new “beta” or “design” > > section under our docs in > > http://trafficcontrol.apache.org/docs/latest/index.html . This would > > unify us into a single documentation format, simplify the transition from > > design to publication, and eliminate the need to support a wiki > altogether. > > > > > > Would love feedback on this: > > > > > > 1. Move to Github wiki > > > > > > Or > > > > > > 1. Move to a new “beta” section under > > http://trafficcontrol.apache.org/docs/latest/index.html > > > > > > Ryan Durfey > > > Sr. Product Manager - CDN | Comcast Technology Solutions > > > 1899 Wynkoop Ste. 550 | Denver, CO 80202 > > > M | 303-524-5099 > > > [email protected]<mailto:[email protected]> > > > CDN Support (24x7): 866-405-2993 or [email protected]<mailto: > > [email protected]> > > > > > > > >
