That is a valid point. I guess the end of the day it depends on how Rainer wants it added really. I'll get everything in place with what I have so I can version my initial work. If he wants to merge that info the primary repo, I can move things around and do a PR for that easily enough. :)
-- James -----Original Message----- From: [email protected] [mailto:[email protected]] On Behalf Of David Lang Sent: Friday, December 13, 2013 12:44 PM To: rsyslog-users Subject: Re: [rsyslog] doc contributions woudln't you want the .rst files to be versionsed as well? why make it a separate repository? having it in one repository is a lot more convienient, and it's a lot easier to submit one pull request to add a feature and documentation for the feature if the documentation is in the same repo as the code than if they are separated. David Lang On Fri, 13 Dec 2013, Boylan, James wrote: > David - > > What I'm working on, if it turns out well, will be the .rst files used by > sphinx to generate the final html documentation. This has no place in the > primary rsyslog repo. If it works as I hope it will in testing, the > outputting html that it generates would make sense to have there, but not > this portion that I'm working on. > > -- James > > -----Original Message----- > From: [email protected] > [mailto:[email protected]] On Behalf Of David Lang > Sent: Friday, December 13, 2013 12:31 PM > To: rsyslog-users > Subject: Re: [rsyslog] doc contributions > > just work with the master repo. If all you are doing is doc changes, the fact > that the main repo has code in it won't matter to you. just fork, edit and > send pull requests. > > David Lang > > On Fri, 13 Dec 2013, Boylan, James wrote: > >> Currently there is no documents repo. :) I was just going to create a >> starting on my account to save Rainer time. Transferring it over to the >> Rsyslog organization later takes no time at all. >> >> -- James >> >> >> -----Original Message----- >> From: [email protected] >> [mailto:[email protected]] On Behalf Of Otis >> Gospodnetic >> Sent: Friday, December 13, 2013 11:23 AM >> To: rsyslog-users >> Subject: Re: [rsyslog] doc contributions >> >> Why not just fork + add/edit + send a PR? I just did that for some minor >> README mods. >> >> Otis >> -- >> Performance Monitoring * Log Analytics * Search Analytics Solr & >> Elasticsearch Support * http://sematext.com/ >> >> >> On Fri, Dec 13, 2013 at 12:20 PM, Boylan, James >> <[email protected]>wrote: >> >>> I've started digging in with the link that Rainer gave me. It is an >>> good start. I'm going to look into customizing the output to be >>> something more familiar. That being said, the really nice part is >>> that once this is done, from what I can tell, the raw .rst files >>> that are used to generate everything once uploaded into github will >>> be viewable right there in a nice, clean format that is comparable to the >>> outputted material. >>> >>> Rainer - >>> >>> I'm going to create a rsyslog-docs repo in my personal account to >>> commit to. Once I get something solid to work with, I'll toss a link >>> for everyone to look at and if everyone likes it we can move it into >>> the rsyslog organization on github. >>> >>> -- James >>> >>> -----Original Message----- >>> From: [email protected] [mailto: >>> [email protected]] On Behalf Of Otis Gospodnetic >>> Sent: Friday, December 13, 2013 10:27 AM >>> To: rsyslog-users >>> Subject: Re: [rsyslog] doc contributions >>> >>> Progress, not perfection. +1. :) >>> >>> Fingers crossed that James' research around doc format and >>> conversion results in something actionable. >>> >>> Otis >>> -- >>> Performance Monitoring * Log Analytics * Search Analytics Solr & >>> Elasticsearch Support * http://sematext.com/ >>> >>> >>> On Fri, Dec 13, 2013 at 11:13 AM, Rainer Gerhards >>> <[email protected]>wrote: >>> >>>> On Fri, Dec 13, 2013 at 4:11 PM, Otis Gospodnetic < >>>> [email protected]> wrote: >>>> >>>>> Btw. I'm confused now. Where are the docs going to live? My >>>>> feeling was Github, so I'm not sure why WP account would be needed. >>>> >>>> >>>> Tactical vs. strategical approach. We have seen that folks have >>>> problems with the current HTML format. A very simple and instant >>>> solution is to use the project web directly. We do this already for >>>> FAQ-type of things, or things that otherwise do make limited sense >>>> inside the doc set itself. An example for the latter is the dynamic >>>> repository pointer I posted today -- the whole point is that it is >>>> NOT inside the tarball, so that we can change it -for all doc >>>> versions- when there is need to. Another thing is policies that may >>>> change over >>> time. >>>> >>>> In any case, using WP gets us started today, whereas otherwise we >>>> need to wait until agreement on new doc system everybody feels >>>> comfortable with. I love the current momentum, and I fear that now >>>> waiting for the >>> "right" >>>> solution will cause loss of this momentum. In the longer term, all >>>> of this can be integrated into the new doc that hopefully becomes >>>> available within the next couple of month. >>>> >>>> Does this sound fair enough? >>>> >>>> Rainer >>>> >>>>> This doesn't feel >>>>> right... don't you want to have just 1 place for docs that people >>>>> contribute to? (and then figure out how to transform to other >>>>> formats to publish elsewhere, if needed). >>>>> >>>>> >>>> Thanks, >>>>> Otis >>>>> -- >>>>> Performance Monitoring * Log Analytics * Search Analytics Solr & >>>>> Elasticsearch Support * http://sematext.com/ >>>>> >>>>> >>>>> On Fri, Dec 13, 2013 at 3:46 AM, Radu Gheorghe >>>>> <[email protected] >>>>>> wrote: >>>>> >>>>>> Hi Rainer, >>>>>> >>>>>> Yes, thanks, I want :) >>>>>> >>>>>> Though I think I'll begin by contributing doc improvements via >>>>>> GitHub first. I'll also think of an (easy) way to make the >>>>>> documentation more obvious, more up-to-date. >>>>>> >>>>>> In the light of the latest discussions, this is easier said than >>>>>> done, >>>> so >>>>>> for now I think we have quite a lot of ideas and we need to >>>>>> switch to actually doing them :) >>>>>> >>>>>> >>>>>> 2013/12/13 Rainer Gerhards <[email protected]> >>>>>> >>>>>>> Radu, James, all, >>>>>>> >>>>>>> if you like, I can create accounts for you on the rsyslog site >>>>>>> so >>>> that >>>>>> you >>>>>>> can create FAQ and similar content right there. This is a pretty >>>> plain >>>>>>> Wordpress site, so no need to know HTML or anything else but how >>>>>>> to >>>>> use a >>>>>>> browser ;) >>>>>>> >>>>>>> Let me know and we can get this started *today*. >>>>>>> >>>>>>> Rainer >>>>>> >>>>> _______________________________________________ >>>>> rsyslog mailing list >>>>> http://lists.adiscon.net/mailman/listinfo/rsyslog >>>>> http://www.rsyslog.com/professional-services/ >>>>> What's up with rsyslog? Follow https://twitter.com/rgerhards NOTE >>>>> WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a >>>>> myriad of sites beyond our control. PLEASE UNSUBSCRIBE and DO NOT >>>>> POST if you DON'T LIKE THAT. >>>>> >>>> _______________________________________________ >>>> rsyslog mailing list >>>> http://lists.adiscon.net/mailman/listinfo/rsyslog >>>> http://www.rsyslog.com/professional-services/ >>>> What's up with rsyslog? Follow https://twitter.com/rgerhards NOTE >>>> WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a myriad >>>> of sites beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if >>>> you DON'T LIKE THAT. >>>> >>> _______________________________________________ >>> rsyslog mailing list >>> http://lists.adiscon.net/mailman/listinfo/rsyslog >>> http://www.rsyslog.com/professional-services/ >>> What's up with rsyslog? Follow https://twitter.com/rgerhards NOTE WELL: >>> This is a PUBLIC mailing list, posts are ARCHIVED by a myriad of >>> sites beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if you >>> DON'T LIKE THAT. >>> _______________________________________________ >>> rsyslog mailing list >>> http://lists.adiscon.net/mailman/listinfo/rsyslog >>> http://www.rsyslog.com/professional-services/ >>> What's up with rsyslog? Follow https://twitter.com/rgerhards NOTE >>> WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a myriad >>> of sites beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if >>> you DON'T LIKE THAT. >>> >> _______________________________________________ >> rsyslog mailing list >> http://lists.adiscon.net/mailman/listinfo/rsyslog >> http://www.rsyslog.com/professional-services/ >> What's up with rsyslog? Follow https://twitter.com/rgerhards NOTE WELL: This >> is a PUBLIC mailing list, posts are ARCHIVED by a myriad of sites beyond our >> control. PLEASE UNSUBSCRIBE and DO NOT POST if you DON'T LIKE THAT. >> _______________________________________________ >> rsyslog mailing list >> http://lists.adiscon.net/mailman/listinfo/rsyslog >> http://www.rsyslog.com/professional-services/ >> What's up with rsyslog? Follow https://twitter.com/rgerhards NOTE >> WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a myriad of sites >> beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if you DON'T LIKE >> THAT. >> > _______________________________________________ > rsyslog mailing list > http://lists.adiscon.net/mailman/listinfo/rsyslog > http://www.rsyslog.com/professional-services/ > What's up with rsyslog? Follow https://twitter.com/rgerhards NOTE WELL: This > is a PUBLIC mailing list, posts are ARCHIVED by a myriad of sites beyond our > control. PLEASE UNSUBSCRIBE and DO NOT POST if you DON'T LIKE THAT. > _______________________________________________ > rsyslog mailing list > http://lists.adiscon.net/mailman/listinfo/rsyslog > http://www.rsyslog.com/professional-services/ > What's up with rsyslog? Follow https://twitter.com/rgerhards NOTE > WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a myriad of sites > beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if you DON'T LIKE THAT. > _______________________________________________ rsyslog mailing list http://lists.adiscon.net/mailman/listinfo/rsyslog http://www.rsyslog.com/professional-services/ What's up with rsyslog? Follow https://twitter.com/rgerhards NOTE WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a myriad of sites beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if you DON'T LIKE THAT. _______________________________________________ rsyslog mailing list http://lists.adiscon.net/mailman/listinfo/rsyslog http://www.rsyslog.com/professional-services/ What's up with rsyslog? Follow https://twitter.com/rgerhards NOTE WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a myriad of sites beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if you DON'T LIKE THAT.
