Re: short intro to debian documentation / Re: Outreachy project about improving documentation and website content (Re: Sign up to mentor for Outreachy Round 15)

2017-10-05 Thread Abelmbula 
Hi Joost,

I think I do have some spare time to work on mentoring and the proposal you 've 
mentioned appears to be good enough. Is there already a mentor and co-mentor 
for this term?

Best wishes,
Abel

Sent with [ProtonMail](https://protonmail.com) Secure Email.

>  Original Message 
> Subject: short intro to debian documentation / Re: Outreachy project about 
> improving documentation and website content (Re: Sign up to mentor for 
> Outreachy Round 15)
> Local Time: October 5, 2017 4:43 AM
> UTC Time: October 5, 2017 2:43 AM
> From: joostvb-debian-doc-2017100...@mdcc.cx
> To: Keerthana Krishnan <contactkeerth...@gmail.com>
> debian-outre...@lists.debian.org, debian-www <debian-www@lists.debian.org>, 
> debian-...@lists.debian.org
>
> Hi Keerthana,
>
> On Sun, Sep 10, 2017 at 11:22:05PM +0530, Keerthana Krishnan wrote:
>> Laura wrote:
>> > What follows is about the website part, I"m not member of the
>> > documentation team
>> > nor am much familiarized with their repos/sources.
>> >
>> > I never mentored in Outreachy/GSoC and I think I personally have not enough
>> > spare time to devote to do a full mentoring (or co-mentoring) in this term,
>> > but I can help in the technical part of changing the website (for example,
>> > helping with the wml syntax, or if the intern submits the proposed changes
>> > as bugs to the www.debian.org pseudopackages, I can review them and upload
>> > them when they are ready. Well, if the outreachy intern sends their
>> > "deliverables" in form of patches, anybody in the website team can
>> > review/upload ;) I just mean that I would try to prioritize those so you
>> > can evaluate their work as mentor based in the team output).
>> >
>> > Maybe you can find useful to use usertags
>> >
>> > https://wiki.debian.org/bugs.debian.org/usertags
>> >
>> > to categorize as "content" or "documentation" the website bugs that the
>> > intern
>> > can work on:
>> >
>> > For now, we have the following bugs tagged as "content":
>> >
>> > https://udd.debian.org/cgi-bin/bts-usertags.cgi?tag=
>> > content=www.debian.org%40packages.debian.org
>> >
>> > Maybe there is another (better) way to do this, but as I said, I have no
>> > experience mentoring.
>
> Apart from what Laura said, I can add some pointers to documentation-work (not
> the Debian website stuff). All what she said is true for me and documentation
> too, especially this: I myself have little time, but I can give a hand here 
> and
> there. Anyway:
>
> We have
>
> Debian GNU/Linux FAQ
> Debian Installation Guide
> Debian Release Notes
> Debian Reference Card
> The Debian Administrator"s Handbook
> Debian Developer"s Reference
> Guide for Debian Maintainers
> Debian New Maintainers" Guide
>
> and other documents. Most of them are maintained in some form of XML, most of
> them are maintained using git, and for most of them the
> debian-...@lists.debian.org list is used for discussing issues. Most of them
> are published on www.debian.org and also in the form of a Debian package (so
> people can do e.g. "sudo apt install debian-faq" to have a local copy of the
> Debian GNU/Linux FAQ .) Most of them are available in both HTML and PDF, and
> in multiple languages.
>
> At https://www.debian.org/doc/ you can find an overview of which documents are
> maintained within Debian, from a user/reader point of view.
>
> At https://www.debian.org/doc/ddp there"s an overview from a documentation
> maintainer point of view.
>
> Linked from there, there is e.g.
> https://www.debian.org/doc/user-manuals#relnotes with information about
> maintaining the Debian Release Notes. And linked from there there is
> https://bugs.debian.org/cgi-bin/pkgreport.cgi?pkg=release-notes;dist=unstable
> which is an overview of the current open bugs in the Release Notes document.
>
> Does this work to get you started? Please let me know if you have any other
> questions.
>
> Thanks for your interest! Bye,
>
> Joost

short intro to debian documentation / Re: Outreachy project about improving documentation and website content (Re: Sign up to mentor for Outreachy Round 15)

2017-10-04 Thread Joost van Baal-Ilić 
Hi Keerthana,

On Sun, Sep 10, 2017 at 11:22:05PM +0530, Keerthana Krishnan wrote:
> Laura wrote:
> > What follows is about the website part, I'm not member of the
> > documentation team
> > nor am much familiarized with their repos/sources.
> >
> > I never mentored in Outreachy/GSoC and I think I personally have not enough
> > spare time to devote to do a full mentoring (or co-mentoring) in this term,
> > but I can help in the technical part of changing the website (for example,
> > helping with the wml syntax, or if the intern submits the proposed changes
> > as bugs to the www.debian.org pseudopackages, I can review them and upload
> > them when they are ready. Well, if the outreachy intern sends their
> > "deliverables" in form of patches, anybody in the website team can
> > review/upload ;) I just mean that I would try to prioritize those so you
> > can evaluate their work as mentor based in the team output).
> >
> > Maybe you can find useful to use usertags
> >
> > https://wiki.debian.org/bugs.debian.org/usertags
> >
> > to categorize as "content" or "documentation" the website bugs that the
> > intern
> > can work on:
> >
> > For now, we have the following bugs tagged as "content":
> >
> > https://udd.debian.org/cgi-bin/bts-usertags.cgi?tag=
> > content=www.debian.org%40packages.debian.org
> >
> > Maybe there is another (better) way to do this, but as I said, I have no
> > experience mentoring.

Apart from what Laura said, I can add some pointers to documentation-work (not
the Debian website stuff).  All what she said is true for me and documentation
too, especially this: I myself have little time, but I can give a hand here and
there.  Anyway:

We have

 Debian GNU/Linux FAQ
 Debian Installation Guide
 Debian Release Notes
 Debian Reference Card
 The Debian Administrator's Handbook
 Debian Developer's Reference
 Guide for Debian Maintainers
 Debian New Maintainers' Guide

and other documents.  Most of them are maintained in some form of XML, most of
them are maintained using git, and for most of them the
debian-...@lists.debian.org list is used for discussing issues.  Most of them
are published on www.debian.org and also in the form of a Debian package (so
people can do e.g. "sudo apt install debian-faq" to have a local copy of the
Debian GNU/Linux FAQ .)  Most of them are available in both HTML and PDF, and
in multiple languages.

At https://www.debian.org/doc/ you can find an overview of which documents are
maintained within Debian, from a user/reader point of view.

At https://www.debian.org/doc/ddp there's an overview from a documentation
maintainer point of view.

Linked from there, there is e.g.
https://www.debian.org/doc/user-manuals#relnotes with information about
maintaining the Debian Release Notes.  And linked from there there is
https://bugs.debian.org/cgi-bin/pkgreport.cgi?pkg=release-notes;dist=unstable
which is an overview of the current open bugs in the Release Notes document.

Does this work to get you started?  Please let me know if you have any other
questions.

Thanks for your interest! Bye,

Joost



signature.asc
Description: Digital signature

Re: Outreachy project about improving documentation and website content (Re: Sign up to mentor for Outreachy Round 15)

2017-09-10 Thread Keerthana Krishnan 
Hi Laura!


CC'ing website and documentation teams for the case anybody can co-mentor
> with you.
>
> What follows is about the website part, I'm not member of the
> documentation team
> nor am much familiarized with their repos/sources.
>
> I never mentored in Outreachy/GSoC and I think I personally have not enough
> spare time to devote to do a full mentoring (or co-mentoring) in this
> term, but
> I can help in the technical part of changing the website (for example,
> helping
> with the wml syntax, or if the intern submits the proposed changes as bugs
> to
> the www.debian.org pseudopackages, I can review them and upload them when
> they
> are ready. Well, if the outreachy intern sends their "deliverables" in
> form of
> patches, anybody in the website team can review/upload ;) I just mean that
> I
> would try to prioritize those so you can evaluate their work as mentor
> based in
> the team output).
>
> Maybe you can find useful to use usertags
>
> https://wiki.debian.org/bugs.debian.org/usertags
>
> to categorize as "content" or "documentation" the website bugs that the
> intern
> can work on:
>
> For now, we have the following bugs tagged as "content":
>
> https://udd.debian.org/cgi-bin/bts-usertags.cgi?tag=
> content=www.debian.org%40packages.debian.org
>
> Maybe there is another (better) way to do this, but as I said, I have no
> experience mentoring.
>

Thanks so much for sharing and the links. I'll be sure to go through them!

Regards,
Keerthana

Outreachy project about improving documentation and website content (Re: Sign up to mentor for Outreachy Round 15)

2017-09-10 Thread Laura Arjona Reina 
Hello Keerthana

El 10/09/17 a las 06:24, Keerthana Krishnan escribió:
> Dear Molly,
> 
> On 6 September 2017 at 19:43, Molly de Blanc  > wrote:
> 
> Hi Keerthana,
> 
> That all sounds great! Debian has had documentation and translation 
> interns
> before. I think not everyone who has signed up to be a mentor (or who has
> been one) is a DD or DM. This shouldn't be a problem, as long as you're
> ready to help someone go through the process of submitting their work
> upstream (if necessary).
> 
> Ofcourse, I'd do my best to help
> 
> 
> There's a form / template on the projects page:
> https://wiki.debian.org/Outreachy/Round15/Projects
> .
> 
> 
> I've created a basic plan for the project here : [1]
> 
> 
> I did some initial recon and this is my project idea :
> 
> "The goal of this project is to verify and improve the documentation and the
> website content in Debian. Due to its sheer size and variety, many parts of 
> the
> Debian wiki and websites are in dire need of upgrades and fact-checking. 
> Another
> goal is to create beginner-friendly docs to various sections of the Debian
> project to encourage more first-time contributions. "
> 
> Essentially, I want to improve the docs and hopefully make it easier for the
> first-time contributor.
> 
> 
> 
> Do you want to talk a bit about your project idea and what the application
> project should be? Do you want to have a co-mentor or co-mentors?
> 
> 
> Yes, since I'm very new myself it would be awesome to have someone a bit more
> experienced with the documentation and websites to be a co-mentor. I've done
> documentation before, but never for Debian.
> 

CC'ing website and documentation teams for the case anybody can co-mentor with 
you.

What follows is about the website part, I'm not member of the documentation team
nor am much familiarized with their repos/sources.

I never mentored in Outreachy/GSoC and I think I personally have not enough
spare time to devote to do a full mentoring (or co-mentoring) in this term, but
I can help in the technical part of changing the website (for example, helping
with the wml syntax, or if the intern submits the proposed changes as bugs to
the www.debian.org pseudopackages, I can review them and upload them when they
are ready. Well, if the outreachy intern sends their "deliverables" in form of
patches, anybody in the website team can review/upload ;) I just mean that I
would try to prioritize those so you can evaluate their work as mentor based in
the team output).

Maybe you can find useful to use usertags

https://wiki.debian.org/bugs.debian.org/usertags

to categorize as "content" or "documentation" the website bugs that the intern
can work on:

For now, we have the following bugs tagged as "content":

https://udd.debian.org/cgi-bin/bts-usertags.cgi?tag=content=www.debian.org%40packages.debian.org

Maybe there is another (better) way to do this, but as I said, I have no
experience mentoring.

Best regards
-- 
Laura Arjona Reina
https://wiki.debian.org/LauraArjona

> Also, due to this inexperience, I wouldn't mind being a co-mentor who supports
> with the writing and documentation part while someone else with more 
> familiarity
> to the Debian systems is the main mentor
> 
> 
> Thanks for reaching out. It's really cool when people who were mentored 
> want
> to help others get involved. :)
> 
> 
> It feels so great to give back in any way I can!
> 
> 
> Cheers,
> Molly
> 
> 
> 
> [1] :
> https://wiki.debian.org/Outreachy/Round15/NCProjects/Improving%20Documentation%20in%20Debian#preview
> 
> 
> 
> Regards,
> Keerthana