Hi Erwan
> I should be able to provide a script which handles the git stuff, but I > would need some help with the rest, especially the question of receiving > the request from the user. > In case anybody wants to help, including if somebody has a server and they > would be ok to use it for this service, I opened an issue on my repo here: > https://github.com/erwanm/tw-aggregator/issues/81 > I'm not sure that the request handling needs to be automated much. As I mentioned above, any contribution is going to have to be reviewed for accuracy and quality, so it's always going to be a semi-manual process. Overall, I am beginning to worry that this is a bit of a rabbit hole. We're putting effort into engineering a whole new pipeline for contribution requests, somewhat duplicating GitHub. But we don't really know that the contribution requests we'll get will warrant the effort. And even though we're lowering the barriers to contribution, they are still quite high: somebody spotting a typo needs to find out how to clone the wiki, save their changes, and submit the change for review. That's conceptually quite complex. It still seems that the simplest flow for people to fix simple errors like typos is: * Visit http://tiddlywiki.com * Put tiddler into edit mode * Click on the link to edit the tiddler on GitHub * Edit the text * Click a button Clearly, most people would need to be taught how to perform those steps; but so they would if they went the TiddlySpot route. Meanwhile, there are so many other things that we could put effort into: * Proper multi-user support for the Node.js configuration * Establishing a community documentation space * Getting third-party plugins into the plugin library * Building a better library of editions * More cool features built on top of the community aggregator * Federation The minimum work to get this new idea of contributing docs changes via TiddlySpot is figuring out a process for generating a pull request. As stated above, I think a prerequisite is that the docs plugin includes the commit ID from which it was generated. Best wishes Jeremy. > > > Regards, > Erwan > > > > On 20/09/15 16:17, Jeremy Ruston wrote: > > Hi Erwan > > So basically I think it's possible with an aggregator-like system to: >> > > Have you seen the process I use with the Translators edition; it's very > similar: > > > http://tiddlywiki.com/prerelease/editions/translators/#Extracting%20Translations > > >> * how to transmit the name/address of the wiki to the aggregator? >> > > RSS solved this problem by having dedicated "ping" servers. In our case, > wikis that want to be aggregated could perform an HTTP POST to > https://ping.tiddlywiki.com, with the payload being the URL of the wiki. > > That would only work if you were in a position to have a server that was > up all the time. An alternative might be to re-use an existing > infrastructure; for example, having wiki authors tweet their updates with a > hashtag. > > >> * if the TW repo has changed since the revision uploaded to tiddlyspot, >> the commit would revert these modifications. as far as I know, the only way >> to avoid that is to know exactly which revision was used on the tiddlyspot >> wiki, but I don't see how this is possible. >> > > The core documentation plugin can be given a finer grained version number > that maybe even includes includes the commit details. > > >> * I'm not sure what to do at the end: is it possible to send a github >> pull request programmatically? or maybe the commit could be pushed to a >> special repo or branch? >> > > Yes, there's an extensive API for GitHub, and it's quite easy to create > pull requests automatically. > > >> * modifications from several wikis can cause conflicts as well >> > > For tiddlywiki.com itself, I think it's reasonable that the docs should > have a manual editorial process. Some details of a contribution might be > inaccurate; that's OK for a community wiki, but I don't think it's OK for > the canonical reference documentation.to > > Many thanks for your continued work on this stuff, it's developing nicely, > > Best wishes > > Jeremy. > > (disclaimer: I'm familiar with git but no expert) >> >> >> Regards >> Erwan >> >> >> >> >> >> >> On 15/09/15 17:18, Jeremy Ruston wrote: >> >> Following up some recent discussions about making it easier for people to >> contribute improvements to the documentation on tiddlywiki.com, I've >> been experimenting with a new edition for documentation contributors: >> >> http://tiddlywiki.com/prerelease/editions/tw5.com-docs/ >> >> It's based on a new plugin $:/plugins/tiddlywiki/tw5.com-docs that >> contains all the documentation tiddlers from tiddlywiki.com. The >> advantage is that it's easier to tell which tiddlers you've modified, and >> to revert to the original. >> >> The idea is that a would-be contributor would clone this edition to >> TiddlySpot (step-by-step instructions forthcoming), and then make their >> changes, saving them back to TiddlySpot. I, or anyone else, can fairly >> easily then pick up the wiki and extract the changed tiddlers into a pull >> request. >> >> One shortcoming at the moment is that TiddlyWiki gives a warning each >> time you modify a shadow tiddler. >> >> A desirable feature is the ability to see line-by-line diffs for the >> changes, and perhaps to be able to easily export a JSON file of the changed >> tiddlers. >> >> Anyhow, feedback and questions are welcome, >> >> Best wishes >> >> Jeremy. >> >> >> -- >> Jeremy Ruston >> mailto:jeremy.rus...@gmail.com >> -- >> You received this message because you are subscribed to the Google Groups >> "TiddlyWiki" group. >> To unsubscribe from this group and stop receiving emails from it, send an >> email to <tiddlywiki+unsubscr...@googlegroups.com> >> tiddlywiki+unsubscr...@googlegroups.com. >> To post to this group, send email to <tiddlywiki@googlegroups.com> >> tiddlywiki@googlegroups.com. >> Visit this group at http://groups.google.com/group/tiddlywiki. >> To view this discussion on the web visit >> <https://groups.google.com/d/msgid/tiddlywiki/CAPKKYJbx%3D28BjWYwra3%3DWjmS0fd8FjKmT0JQ4uK%3DXwK-1f%2B9RA%40mail.gmail.com?utm_medium=email&utm_source=footer> >> https://groups.google.com/d/msgid/tiddlywiki/CAPKKYJbx%3D28BjWYwra3%3DWjmS0fd8FjKmT0JQ4uK%3DXwK-1f%2B9RA%40mail.gmail.com >> . >> For more options, visit https://groups.google.com/d/optout. >> >> >> -- >> You received this message because you are subscribed to the Google Groups >> "TiddlyWiki" group. >> To unsubscribe from this group and stop receiving emails from it, send an >> email to <tiddlywiki+unsubscr...@googlegroups.com> >> tiddlywiki+unsubscr...@googlegroups.com. >> To post to this group, send email to <tiddlywiki@googlegroups.com> >> tiddlywiki@googlegroups.com. >> Visit this group at http://groups.google.com/group/tiddlywiki. >> To view this discussion on the web visit >> <https://groups.google.com/d/msgid/tiddlywiki/55F9C37B.6050608%40gmail.com?utm_medium=email&utm_source=footer> >> https://groups.google.com/d/msgid/tiddlywiki/55F9C37B.6050608%40gmail.com >> . >> For more options, visit https://groups.google.com/d/optout. >> > > > > -- > Jeremy Ruston > mailto:jeremy.rus...@gmail.com > > > -- Jeremy Ruston mailto:jeremy.rus...@gmail.com -- You received this message because you are subscribed to the Google Groups "TiddlyWiki" group. To unsubscribe from this group and stop receiving emails from it, send an email to tiddlywiki+unsubscr...@googlegroups.com. To post to this group, send email to tiddlywiki@googlegroups.com. Visit this group at http://groups.google.com/group/tiddlywiki. To view this discussion on the web visit https://groups.google.com/d/msgid/tiddlywiki/CAPKKYJYKUTekAm5rbQktPB404pgCvcLwe_0Nn%2B_rvc%2B61ezjow%40mail.gmail.com. For more options, visit https://groups.google.com/d/optout.
