Re: Contributing to Django Documentation

['Adam Johnson' via Django developers (Contributions to Django itself)]

Hi Cammil

For small changes it's fine to just open a PR. For larger changes I often
open a ticket with the suggested change, and then maybe a PR to go along to
show what it would look like.

Do check out the Contributing Guide:
https://docs.djangoproject.com/en/stable/internals/contributing/
And the “Advice for New Contributors” section:
https://docs.djangoproject.com/en/stable/internals/contributing/new-contributors/
. And it can be worth working through the “Writing Your First Patch”
tutorial: https://docs.djangoproject.com/en/stable/intro/contributing/ .

Happy to be tagged on GitHub / Trac.

Good luck and may the odds be ever in your favour!

Adam

On Fri, 26 Feb 2021 at 09:03, cta...@gmail.com  wrote:

> Hi Everyone,
>
> I'd like to start contributing to Django, firstly by helping to improve
> the documentation. There are no particular inaccuracies, but rather I would
> like to have a go at improving the style, content and organisation.
>
> How should I go about suggesting improvements, and getting feedback on
> them, before I propose a specific change (which I assume I would do with a
> ticket)?
>
> Many thanks,
> Cammil
>
> --
> You received this message because you are subscribed to the Google Groups
> "Django developers (Contributions to Django itself)" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to django-developers+unsubscr...@googlegroups.com.
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/django-developers/c604bd2a-5ed3-4d15-9334-2d8fb8c48fcfn%40googlegroups.com
> 
> .
>


-- 
Adam

-- 
You received this message because you are subscribed to the Google Groups 
"Django developers  (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-developers+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-developers/CAMyDDM3SPA2vEodawYcnN9xPX%2B2oeRSdrmdSby%3Dii%2Br6Kht0cQ%40mail.gmail.com.

Contributing to Django Documentation

[cta...@gmail.com]

Hi Everyone,

I'd like to start contributing to Django, firstly by helping to improve the 
documentation. There are no particular inaccuracies, but rather I would 
like to have a go at improving the style, content and organisation.

How should I go about suggesting improvements, and getting feedback on 
them, before I propose a specific change (which I assume I would do with a 
ticket)?

Many thanks,
Cammil

-- 
You received this message because you are subscribed to the Google Groups 
"Django developers  (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-developers+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-developers/c604bd2a-5ed3-4d15-9334-2d8fb8c48fcfn%40googlegroups.com.

Re: Reshaping the "Contributing to Django" documentation

[Julien Phalip]

On May 21, 2:15 am, "Jonas H."  wrote:
> > "[...] try and duplicate it. If you can duplicate it [...]"
>
> I'd stick with "reproduce" here because "duplicate" may be confused with
> "duplicate tickets".

Yes that's a good point. I fixed that in the latest patch. Thanks!

-- 
You received this message because you are subscribed to the Google Groups 
"Django developers" group.
To post to this group, send email to django-developers@googlegroups.com.
To unsubscribe from this group, send email to 
django-developers+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/django-developers?hl=en.

Re: Reshaping the "Contributing to Django" documentation

[Julien Phalip]

On May 21, 1:33 am, Waylan Limberg  wrote:
> One nitpick thought. I expect that people reporting bugs will go to
> the "bugs-and-features" page, which is fine. However, as is often the
> case, when their ticket is marked "accepted" (or some other triage
> stage) they often get confused about what that means (as we all know).
> If they are only looking to get their one ticket fixed, I doubt they
> will find on there own the explanations of the various stages now
> under "triaging-tickets" ("I just want my one ticket fixed. I don't
> have time to work on other peoples tickets, Why would I look there?").
> Perhaps a link to those explanations should be added to the
> "bugs-and-features" section? Just a thought.

Thanks for the tip! In the latest patch I've added such links at the
bottom of those two sections:
http://dl.dropbox.com/u/3364022/djangodoc/internals/contributing/bugs-and-features.html#reporting-bugs
http://dl.dropbox.com/u/3364022/djangodoc/internals/contributing/bugs-and-features.html#requesting-features

-- 
You received this message because you are subscribed to the Google Groups 
"Django developers" group.
To post to this group, send email to django-developers@googlegroups.com.
To unsubscribe from this group, send email to 
django-developers+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/django-developers?hl=en.

Re: Reshaping the "Contributing to Django" documentation

[Jonas H.]

"[...] try and duplicate it. If you can duplicate it [...]"


I'd stick with "reproduce" here because "duplicate" may be confused with 
"duplicate tickets".


--
You received this message because you are subscribed to the Google Groups "Django 
developers" group.
To post to this group, send email to django-developers@googlegroups.com.
To unsubscribe from this group, send email to 
django-developers+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/django-developers?hl=en.

Re: Reshaping the "Contributing to Django" documentation

[Waylan Limberg]

On Fri, May 20, 2011 at 5:31 AM, Julien Phalip  wrote:
> Hi there,
>
> I've been working on reshaping the documentation about contributing to
> Django, in particular the rather dense historical page [1] and the
> excellent recently added how-to guide [2]. This documentation has sort
> of grown organically over the years and has become a bit difficult to
> read, so I tried to improve things a bit.
>
> I've submitted a patch in the designated ticket: 
> http://code.djangoproject.com/ticket/15796

Awesome!

One nitpick thought. I expect that people reporting bugs will go to
the "bugs-and-features" page, which is fine. However, as is often the
case, when their ticket is marked "accepted" (or some other triage
stage) they often get confused about what that means (as we all know).
If they are only looking to get their one ticket fixed, I doubt they
will find on there own the explanations of the various stages now
under "triaging-tickets" ("I just want my one ticket fixed. I don't
have time to work on other peoples tickets, Why would I look there?").
Perhaps a link to those explanations should be added to the
"bugs-and-features" section? Just a thought.

-- 

\X/ /-\ `/ |_ /-\ |\|
Waylan Limberg

-- 
You received this message because you are subscribed to the Google Groups 
"Django developers" group.
To post to this group, send email to django-developers@googlegroups.com.
To unsubscribe from this group, send email to 
django-developers+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/django-developers?hl=en.

Reshaping the "Contributing to Django" documentation

[Julien Phalip]

Hi there,

I've been working on reshaping the documentation about contributing to
Django, in particular the rather dense historical page [1] and the
excellent recently added how-to guide [2]. This documentation has sort
of grown organically over the years and has become a bit difficult to
read, so I tried to improve things a bit.

I've submitted a patch in the designated ticket: 
http://code.djangoproject.com/ticket/15796
You can also browse the html output here:
http://dl.dropbox.com/u/3364022/djangodoc/internals/contributing/index.html

The vast majority of the content was preserved. What I've done is:

- broke the content down into logical sections.
- merged information about "the documentation" from [1] and [3].
- merged information about "ticket triage" from [1] and [2].
- made a few edits, clarified a few things here and there, shifted a
few bits around and smoothed out the transitions.
- cross-linked the various sections.
- added descriptions for the recently added "type" and "severity"
attributes.
- added a few suggestions for ways new contributors can help.

I hope that it turns this documentation into a more maintainable and
extensible shape and, as a result, that it will facilitate
contributions from the community.

It is a big change so I thought I'd bring it up here in case you have
ideas and suggestions to improve it further or differently. Any
feedback is welcome.

Thanks a lot!

Julien

[1] http://docs.djangoproject.com/en/dev/internals/contributing/
[2] http://docs.djangoproject.com/en/dev/howto/contribute/
[3] http://docs.djangoproject.com/en/dev/internals/documentation/

-- 
You received this message because you are subscribed to the Google Groups 
"Django developers" group.
To post to this group, send email to django-developers@googlegroups.com.
To unsubscribe from this group, send email to 
django-developers+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/django-developers?hl=en.