[new contributor] Where to find resources to make changes to djangoproject.com ?

[Gabriel Augendre]

Hello there !

I'm not a beginner in software development but I'm a new contributor to Django and I took this ticket from Trac : https://code.djangoproject.com/ticket/30780

I made some progress creating a floating button to link to the FAQ but I'm having trouble finding where to edit the documentation pages themselves.

After running ./manage.py update_docs, I had some content that looked like documentation pages.

In data/djangodocs/sources/dev/docs/index.txt, I found some text that looked nearly exactly like the index page of the documentation, with the exception that in this file there is already a section about where to get help and it doesn't appear on the website served by ./manage.py runserver.

Could someone show me around, explaining the build process, where to edit the pages and what to do in order to see the results ?

Thanks in advance for any help :)

Cheers,

Gabriel

[Abhijeet Viswa]

Hey,

You can find the tutorial for Writing documentation here:
https://docs.djangoproject.com/en/dev/internals/contributing/writing-documentation/

The raw document files are basically text files written using
reStructuredText syntax. You can find the inside the docs folder. Just
edit the text files and then build the docs and see preview your
changes. Commit the changes to the text files and make a PR.

Cheers.

> --
> 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-develop...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/60bf0ace-48aa-42aa-be31-208b200d7d4e%40googlegroups.com.



--
Abhijeet

[Adam Johnson]

This guide may also be useful: https://docs.djangoproject.com/en/3.0/intro/contributing/

To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/CAP1-Yrp%2BW-HZZKLhCYGJvXBR_zX%3DnNWsAAXM%3DBNmVVn_R7hm2w%40mail.gmail.com.

--

Adam

[Gabriel Augendre]

Thanks to both of you for your help, I've been able to push a patch :)

See https://github.com/django/django/pull/12238 and https://github.com/django/djangoproject.com/pull/969

Cheers,

Gabriel

On Friday, December 20, 2019 at 7:54:19 PM UTC+1, Adam Johnson wrote:

This guide may also be useful: https://docs.djangoproject.com/en/3.0/intro/contributing/

On Fri, 20 Dec 2019 at 14:11, Abhijeet Viswa <abhije...@gmail.com> wrote:

Hey,

You can find the tutorial for Writing documentation here:
https://docs.djangoproject.com/en/dev/internals/contributing/writing-documentation/

The raw document files are basically text files written using
reStructuredText syntax. You can find the inside the docs folder. Just
edit the text files and then build the docs and see preview your
changes. Commit the changes to the text files and make a PR.

Cheers.

On Fri, 20 Dec 2019 at 18:03, Gabriel Augendre <gab...@augendre.info> wrote:
>
> Hello there !
>
> I'm not a beginner in software development but I'm a new contributor to Django and I took this ticket from Trac : https://code.djangoproject.com/ticket/30780
>
> I made some progress creating a floating button to link to the FAQ but I'm having trouble finding where to edit the documentation pages themselves.
> After running ./manage.py update_docs, I had some content that looked like documentation pages.
> In data/djangodocs/sources/dev/docs/index.txt, I found some text that looked nearly exactly like the index page of the documentation, with the exception that in this file there is already a section about where to get help and it doesn't appear on the website served by ./manage.py runserver.
>
> Could someone show me around, explaining the build process, where to edit the pages and what to do in order to see the results ?
>
> Thanks in advance for any help :)
>
> Cheers,
> Gabriel
>
> --
> 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-d...@googlegroups.com.

> To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/60bf0ace-48aa-42aa-be31-208b200d7d4e%40googlegroups.com.



--
Abhijeet

--
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-d...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/CAP1-Yrp%2BW-HZZKLhCYGJvXBR_zX%3DnNWsAAXM%3DBNmVVn_R7hm2w%40mail.gmail.com.

--

Adam