[CentOS-docs] Docs strategy and tactics [RFC]

Wed Mar 25 08:19:38 UTC 2015
kunaal jain <kunaalus at gmail.com>

Hi Kartsen,

you'll have my proposal by the end of the day. I am not good at
writing content. :(  I have sorted out all the technicalities though.

Regards,
Kunal Jain

On Tue, Mar 24, 2015 at 5:48 AM, Karsten Wade <kwade at redhat.com> wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
>
> Kunaal:
>
> I know you are still researching, but I think you may have enough to
> write up your proposal in the Melange tool. The deadline for
> applications to be input is 27 March at 19:00 UTC. However, that is
> followed by a few more weeks for you to work with me and other
> mentors/helpers to refine the application. So your next step is to
> work on and submit that proposal.
>
> https://www.google-melange.com/gsoc/profile/register/student/google/gsoc
> 2015
>
> Once we have you (and any others) in the Melange system, I'm going to
> work with Shaun and any others to help narrow my scope to something
> that is and doable in a summer's time. Shaun's warnings about the
> difficulties of syncing with an upstream are really important, and we
> may want to think of a way to loosely couple rather than try to solve
> the problem in general.
>
> If folks don't mind, I'd appreciate continuing at least some of this
> discussion on this list -- we need to make sure that this toolchain
> lines up with our process, and that process is itself sane and doable.
>
> Regards,
>
> - - Karsten
>
> On 03/17/2015 03:21 AM, kunaal jain wrote:
>> On Tue, Mar 17, 2015 at 3:30 AM, Shaun McCance <shaunm at redhat.com>
>> wrote:
>>> Just to throw another wrench in: I don't know what DigitalOcean's
>>> docs are like, but Linode generally provides their guides for
>>> Ubuntu, Debian, and CentOS. However, for whatever reason, they
>>> tend to do Ubuntu first. So there are bunches of guides without
>>> CentOS versions.
>>>
>>> They do allow people outside Linode to submit guides. So outside
>>> of normal CentOS docs, a useful exercise would be for people to
>>> port non-CentOS guides on Linode (and other places) to CentOS. It
>>> would increase mindshare for CentOS.
>>
>> I think with porting of content, main focus should be on new
>> content. If we create the complete documentation procedure i.e.
>> automating this long procedure ----> writing content in markup
>> language -> pull request -> discussion -> changes -> Identify the
>> module and upstream -> converting content in relevant design, style
>> -> pushing to upstream -> updating CentOS docs -> update website.
>>
>> If this toolchain becomes friendly, I am sure even the normal
>> CentOS user, if learns new thing, would happy to write a document
>> about it and push it to us. Even upstream software benefit with
>> this documentation .
>>
>>>
>>> Sure. I've dealt with quite a bit of this while working on GNOME
>>> docs. It's challenging, but mostly enjoyably so. I mentioned to
>>> Karsten off-list that, if you want a usable system at the end,
>>> it's important to really define the workflow and what tools are
>>> needed. I've had quite a
>>
>> Hence this thread comes into existence on this mailing list to
>> discuss the workflow and tools with those people who actually deal
>> with this on frequently basis.
>>
>> This was my attempt to start discussion on technical aspect of
>> this.
>> http://lists.centos.org/pipermail/centos-docs/2015-March/005594.html
>>
>>
>>> few GSoC projects that just ended up as interesting experiments,
>>> but never got used. Interesting experiments can be fine, but not
>>> if your documentation strategy depends on them.
>>
>> I agree. But as Jason said we need to experiment, give people this
>> new option. _______________________________________________
>> CentOS-docs mailing list CentOS-docs at centos.org
>> http://lists.centos.org/mailman/listinfo/centos-docs
>>
>
>
> - --
> Karsten 'quaid' Wade        .^\          CentOS Doer of Stuff
> http://TheOpenSourceWay.org    \  http://community.redhat.com
> @quaid (identi.ca/twitter/IRC)  \v'             gpg: AD0E0C41
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v2
>
> iEYEARECAAYFAlUQrTkACgkQ2ZIOBq0ODEH45ACgnqlD34nmxNGVdZoikHq4tso5
> oaQAn0Yy8BNMZqXQpCgZc5n0+ZF85d5Z
> =4bxB
> -----END PGP SIGNATURE-----
> _______________________________________________
> CentOS-docs mailing list
> CentOS-docs at centos.org
> http://lists.centos.org/mailman/listinfo/centos-docs