[TYPO3-doc] Comments for documentation: In our wiki? In our forum?

Daniel Siepmann daniel.siepmann at typo3.org
Wed Aug 14 23:52:22 CEST 2013


Sorry, I saw the "new" discussion in Thread "Integrating "Disqus" on
docs.typo3.org".

Just ignore my last mail.

Regards, Daniel.

--
Daniel Siepmann
TYPO3 Editorial Team Co-Leader

TYPO3 .... inspiring people to share!
Get involved: typo3.org


On Wed, Aug 14, 2013 at 11:38 PM, Daniel Siepmann
<daniel.siepmann at typo3.org> wrote:
> Hello,
>
> I know this feature from "Mercurial: The Definitive Guide by Bryan
> O'Sullivan" [1] where it's nice integrated. In my personal opinion.
> It looks like a custom solution but perhaps there is a framework or
> other service integrated.
>
> The easiest way would be to show all comments inline inside the
> documentation. Perhaps using AJAX so there won't be much effects on
> the current rendering.
> I don't know where to store the comments. Perhaps we can use the
> Mailinglist or Wiki for this, so they are accessible via other ways.
> (RSS, Mail, etc.)
>
> [1] http://hgbook.red-bean.com/read/file-names-and-pattern-matching.html
>
> Best regards,
>
> Daniel.
>
> --
> Daniel Siepmann
> TYPO3 Editorial Team Co-Leader
>
> TYPO3 .... inspiring people to share!
> Get involved: typo3.org
>
>
> On Sun, Jul 14, 2013 at 10:37 AM, Martin Bless <m.bless at gmx.de> wrote:
>> Hello,
>>
>> quoting from another thread about the possible benefits of having
>> comments on documentation pages:
>>
>>> > What are we really trying to benefit with this comment embedding?
>>
>>> Basically the same that www.php.net/manual/en/ benefits from
>>> (possibly with a higher quality due to the voting functionality):
>>
>>> * Additional explanations/code snippets amending the documentation
>>> * Corrections that might make it into the official docs
>>> * Better interaction with the community
>>
>> I assume that for several good reasons we won't be using a foreign
>> service like Disqus for this. On the other hand we don't have much
>> manpower at hand.
>>
>> Two still very incomplete ideas come creeping up in my mind again
>> and again:
>>
>> - Can we make use of our Wiki for this?
>> - Can we use our mailinglists/forum for this?
>>
>> Just thinking aloud:
>>
>> What if we place a link on each documentation page that links to a
>> corresponding Wiki page? Like:
>> http://docs.typo3.org/typo3cms/TCAReference/Introduction/  ->
>> http://wiki.typo3.org/typo3cms/TCAReference/Introduction/
>>
>> Or if we had a mailing list for comments (mirrored at
>> forum.typo3.org) and we would have a link on each documentation
>> page that links to comments for that page in the list?
>>
>> Feel free to continue with this ideas ...
>>
>> Martin
>>
>> --
>> Certified TYPO3 Integrator | TYPO3 Documentation Team Member
>>
>> http://mbless.de
>> _______________________________________________
>> TYPO3-project-documentation mailing list
>> TYPO3-project-documentation at lists.typo3.org
>> http://lists.typo3.org/cgi-bin/mailman/listinfo/typo3-project-documentation
> _______________________________________________
> TYPO3-project-documentation mailing list
> TYPO3-project-documentation at lists.typo3.org
> http://lists.typo3.org/cgi-bin/mailman/listinfo/typo3-project-documentation


More information about the TYPO3-project-documentation mailing list