[apachecms] contributing documentation for non commiters

[Nicolas Peltier <np...@adobe.com>]

Hi,

i’ve tried yesterday to contribute some documentation but i can’t find how to visualise my changes, i saw the /tools/build/build_site.pl e.g. but after having installed YAML, XML, Twitter, and i don’t remember other deps, i failed to install SVN module dependency on my mac (some build issue), woke up, and told myself there must be an easier way :-)

So i basically added a mdtext file, and modified another with a link to it, ideally i’d only need to visualize the changes on those two files. Can someone tell me how to (simply) do this?

Thanks,
Nicolas

Re: [apachecms] contributing documentation for non commiters

[Nicolas Peltier <np...@adobe.com>]

Thanks Bertrand! it helps, actually used a mix of the online tool for previewing and svn diff for generating the patch

> On 09 Dec 2015, at 11:30, Bertrand Delacretaz <bd...@apache.org> wrote:
> 
> Hi,
> 
> On Tue, Dec 8, 2015 at 10:02 AM, Nicolas Peltier <np...@adobe.com> wrote:
>> ...So i basically added a mdtext file, and modified another with a link to it, ideally i’d only need to visualize
>> the changes on those two files. Can someone tell me how to (simply) do this?...
> 
> As per http://www.apache.org/dev/cmsref.html#non-committer has
> instructions on how to do this, I haven't tested them.
> 
> The CMS has its own flavor of markdown so you might not be able to
> fully validate your content without it. But we can also slightly tweak
> patches that you would provide, if needed. Let's not get in the way of
> people who want to contribute docs ;-)
> 
> -Bertrand

Re: [apachecms] contributing documentation for non commiters

[Bertrand Delacretaz <bd...@apache.org>]

Hi,

On Tue, Dec 8, 2015 at 10:02 AM, Nicolas Peltier <np...@adobe.com> wrote:
> ...So i basically added a mdtext file, and modified another with a link to it, ideally i’d only need to visualize
> the changes on those two files. Can someone tell me how to (simply) do this?...

As per http://www.apache.org/dev/cmsref.html#non-committer has
instructions on how to do this, I haven't tested them.

The CMS has its own flavor of markdown so you might not be able to
fully validate your content without it. But we can also slightly tweak
patches that you would provide, if needed. Let's not get in the way of
people who want to contribute docs ;-)

-Bertrand

Re: [apachecms] contributing documentation for non commiters

[Nicolas Peltier <np...@adobe.com>]

anyone?

> On 08 Dec 2015, at 10:02, Nicolas Peltier <np...@adobe.com> wrote:
> 
> Hi,
> 
> i’ve tried yesterday to contribute some documentation but i can’t find how to visualise my changes, i saw the /tools/build/build_site.pl e.g. but after having installed YAML, XML, Twitter, and i don’t remember other deps, i failed to install SVN module dependency on my mac (some build issue), woke up, and told myself there must be an easier way :-)
> 
> So i basically added a mdtext file, and modified another with a link to it, ideally i’d only need to visualize the changes on those two files. Can someone tell me how to (simply) do this?
> 
> Thanks,
> Nicolas

Re: [apachecms] contributing documentation for non commiters

[Nicolas Peltier <np...@adobe.com>]

Thanks Stefan, ok it’s just i’ve seen several plugins & wanted to double check but ok, will do that, thanks!
> On 08 Dec 2015, at 15:34, Stefan Seifert <ss...@pro-vision.de> wrote:
> 
> well, basically the docs are just files using markdown syntax, so you can use any markdown renderer for previewing them, e.g. [1] (but beware there are subtle differences in interpreting the markdown syntax between various renderers).
> 
> i always edit the files directly, works good enough for me. if there are layout issues either the committer who applies the patch can fix them, or you can submit another patch (a bit inconvenient).
> 
> stefan
> 
> [1] http://markdownlivepreview.com/
> 
> 
>> -----Original Message-----
>> From: Nicolas Peltier [mailto:npeltier@adobe.com]
>> Sent: Tuesday, December 08, 2015 10:02 AM
>> To: dev@sling.apache.org
>> Subject: [apachecms] contributing documentation for non commiters
>> 
>> Hi,
>> 
>> i’ve tried yesterday to contribute some documentation but i can’t find how
>> to visualise my changes, i saw the /tools/build/build_site.pl e.g. but
>> after having installed YAML, XML, Twitter, and i don’t remember other deps,
>> i failed to install SVN module dependency on my mac (some build issue),
>> woke up, and told myself there must be an easier way :-)
>> 
>> So i basically added a mdtext file, and modified another with a link to it,
>> ideally i’d only need to visualize the changes on those two files. Can
>> someone tell me how to (simply) do this?
>> 
>> Thanks,
>> Nicolas

RE: [apachecms] contributing documentation for non commiters

[Stefan Seifert <ss...@pro-vision.de>]

well, basically the docs are just files using markdown syntax, so you can use any markdown renderer for previewing them, e.g. [1] (but beware there are subtle differences in interpreting the markdown syntax between various renderers).

i always edit the files directly, works good enough for me. if there are layout issues either the committer who applies the patch can fix them, or you can submit another patch (a bit inconvenient).

stefan

[1] http://markdownlivepreview.com/


>-----Original Message-----
>From: Nicolas Peltier [mailto:npeltier@adobe.com]
>Sent: Tuesday, December 08, 2015 10:02 AM
>To: dev@sling.apache.org
>Subject: [apachecms] contributing documentation for non commiters
>
>Hi,
>
>i’ve tried yesterday to contribute some documentation but i can’t find how
>to visualise my changes, i saw the /tools/build/build_site.pl e.g. but
>after having installed YAML, XML, Twitter, and i don’t remember other deps,
>i failed to install SVN module dependency on my mac (some build issue),
>woke up, and told myself there must be an easier way :-)
>
>So i basically added a mdtext file, and modified another with a link to it,
>ideally i’d only need to visualize the changes on those two files. Can
>someone tell me how to (simply) do this?
>
>Thanks,
>Nicolas