Hi everyone,
as this is my first post here, I'd like to start by thanking Jeremy and
everyone who contributes to TW, from core development to helping make
the community so engaging. I've discovered TW only a few months ago (I
was lucky to arrive just for the birth of the official TW5), and I've
been hooked by both the great tool that TW is and the good atmosphere of
knowledge sharing in the community.
I agree with Jeremy and everybody in this thread that improving the
documentation process (including the great potential for community
knowledge) becomes more and more important, especially in the
perspective of attracting newcomers.
In general my thoughts on the topic are similar to what most people have
said here. I would like to suggest maybe a couple of points that I think
deserve some attention. Indeed, people with technical skills tend to
focus on the technical side of a problem, and obviously there are highly
skilled people here ;) While this is important, there can be other
angles to look at:
* For example, about the fact that some people are not comfortable using
github, a very simple way to overcome the problem would be to have a few
volunteers who know git who would receive the contributions and make the
pull request for them. I guess something similar could be done for other
things, like translating, so that someone who can translate doesn't need
to have any technical skills.
* Imho, one of the problems with contributing to the official
documentation is that there is no clear guidelines about the structure
or the type of content. I think that it would be very helpful to think
about a detailed plan and identify the missing parts: this way it would
be easier for people who want to contribute to know what to do, and
eventually for newcomers to find their way in the documentation.
I tried to develop these ideas and to imagine how things could work
globally in a more detailed proposition, in case that helps:
http://tw-doc-ideas.tiddlyspot.com
Regards,
Erwan
On 23/11/14 13:21, Jeremy Ruston wrote:
Thanks everyone for their contributions. There are a bunch of good
suggestions in the thread which I'll try to pick up in the hangout on
Tuesday.
A big topic is clearly how we improve the contribution process for the
documentation. I have a couple of thoughts:
* We could initiate a TW5 community space on tiddlyspace along the
lines of tiddlywiki.org <http://tiddlywiki.org> - it's a proven way to
work. It would be good to try out TW5's support for TiddlySpace in a
multiuser setting (since it's not been done before I think there may
be some wrinkles to be ironed out).
* We should support documentation contributions by people taking a
copy of tiddlywiki.com <http://tiddlywiki.com> onto tiddlyspot and
making their edits there. I could easily build a batch file that pulls
down their changes and applies them to the repo, so that I can convert
their changes to a pull request (I don't think there's any avoiding
needing a moderation step for tiddlywiki.com <http://tiddlywiki.com>)
* An alternative workflow for accepting those contributions would be
to support visual diffing in the import manager
I've also got a couple of clarifications.
> Perhaps there's a way to display a sticky above the github issues.
We don't want to discourage people from suggesting and discussing new
features, but lets see how it goes and I can add a banner to the "new
issue" page if needed.
> 4. You may think about a two level plugin list: the top part would
list the plugins that are officially sanctioned and compatible with
the latest release. The bottom part could be a growing list of
webpages where individuals have stored there plugins and goodies they
have created for TW but that may or may not continue to be compatible.
That's pretty much what we've got:
* Plugins listed in http://tiddlywiki.com/#Plugins are the officially
maintained and distributed plugins. They will be automatically
upgraded when using http://tiddlywiki.com/upgrade.html
* Community plugins are listed in http://tiddlywiki.com/#Resources
Perhaps we should maintain a catalogue of community plugins that is
separate from the general resources list.
> Will 1.1.5 and the export feature make release before the moratorium
begins?
Yes, the moratorium would start after 5.1.5's release.
Best wishes
Jeremy
On Sat, Nov 22, 2014 at 6:43 PM, 'Mark S.' via TiddlyWiki
<[email protected] <mailto:[email protected]>> wrote:
Whenever you have an open web page, you end up with spammers
trying to create link drops.
Probably a real wiki (with authentication) or even just a special
thread on this forum would be better. I believe the better wiki
systems track history, so changes can be rolled back when
something useful has been overwritten.
I feel the github process discourages documentation. The problem
is that it's the same system of review for documentation as for
code. Which means that you may have to wait a week or so before
changes get applied, Sure, CODE needs to be thoroughly vetted so
that TW doesn't break. But, unlike code, poor documentation is
usually better than NO documentation, and it can be peer-reviewed
and tweaked as time goes along. It's an odd quirk of human
psychology that people tend to like to correct things that are
already in place rather than creating new content in the first
place. So getting something in place quickly (even if not 100%
perfect) is more important than getting it publisher-ready on the
first draft.
Mark
On Friday, November 21, 2014 6:37:16 PM UTC-8, Jed Carty wrote:
I think that we could try making a public tiddlywiki on
tiddlyspot and make a list of topics people want documentation
for the most, then collect explanations and examples from
people and hopefully get someone who is good at technical
writing or design to collect everything into a nice tiddler we
can submit for inclusion on the main page.
Is there interest in a project like this? It would allow
people to make small updates or suggestions for the
documentation without having to do the entire tiddler by
themselves. Using github isn't hard, but this may encourage
more people to help out. That is if multi-user wikis are a
viable solution, if not we would need someone to manage it,
which may not be better than just using github the way it is now.
--
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 [email protected]
<mailto:[email protected]>.
To post to this group, send email to [email protected]
<mailto:[email protected]>.
Visit this group at http://groups.google.com/group/tiddlywiki.
For more options, visit https://groups.google.com/d/optout.
--
Jeremy Ruston
mailto:[email protected] <mailto:[email protected]>
--
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 [email protected]
<mailto:[email protected]>.
To post to this group, send email to [email protected]
<mailto:[email protected]>.
Visit this group at http://groups.google.com/group/tiddlywiki.
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 [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/tiddlywiki.
For more options, visit https://groups.google.com/d/optout.
