[Django] #26699: Contributing docs should highlight difference between locally-built docs and server docs

35 views
Skip to first unread message

Django

unread,
Jun 2, 2016, 1:44:38 PM6/2/16
to django-...@googlegroups.com
#26699: Contributing docs should highlight difference between locally-built docs
and server docs
-------------------------------+--------------------
Reporter: phildini | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: 1.9
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------+--------------------
If you build the docs locally and open them, they will look different than
the docs on the server.

This is expected but potentially confusing to new contributors. The
contributing docs should talk about this.

--
Ticket URL: <https://code.djangoproject.com/ticket/26699>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Jun 2, 2016, 1:44:43 PM6/2/16
to django-...@googlegroups.com
#26699: Contributing docs should highlight difference between locally-built docs
and server docs
-------------------------------+--------------------------------------
Reporter: phildini | Owner: phildini
Type: Bug | Status: assigned
Component: Documentation | Version: 1.9
Severity: Normal | Resolution:
Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
-------------------------------+--------------------------------------
Changes (by phildini):

* owner: nobody => phildini
* needs_better_patch: => 0
* status: new => assigned
* needs_tests: => 0
* needs_docs: => 0


--
Ticket URL: <https://code.djangoproject.com/ticket/26699#comment:1>

Django

unread,
Jun 2, 2016, 1:49:52 PM6/2/16
to django-...@googlegroups.com
#26699: Contributing docs should highlight difference between locally-built docs
and server docs
--------------------------------------+------------------------------------
Reporter: phildini | Owner: phildini
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: 1.9
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by timgraham):

* type: Bug => Cleanup/optimization
* stage: Unreviewed => Accepted


--
Ticket URL: <https://code.djangoproject.com/ticket/26699#comment:2>

Django

unread,
Jun 2, 2016, 2:03:12 PM6/2/16
to django-...@googlegroups.com
#26699: Contributing docs should highlight difference between locally-built docs
and server docs
--------------------------------------+------------------------------------
Reporter: phildini | Owner: phildini
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: 1.9

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------

Comment (by phildini):

Pull request here: https://github.com/django/django/pull/6690

--
Ticket URL: <https://code.djangoproject.com/ticket/26699#comment:3>

Django

unread,
Jun 2, 2016, 2:06:20 PM6/2/16
to django-...@googlegroups.com
#26699: Contributing docs should highlight difference between locally-built docs
and server docs
--------------------------------------+------------------------------------
Reporter: phildini | Owner: phildini
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: 1.9

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by phildini):

* has_patch: 0 => 1


--
Ticket URL: <https://code.djangoproject.com/ticket/26699#comment:4>

Django

unread,
Jun 2, 2016, 2:11:09 PM6/2/16
to django-...@googlegroups.com
#26699: Contributing docs should highlight difference between locally-built docs
and server docs
--------------------------------------+------------------------------------
Reporter: phildini | Owner: phildini
Type: Cleanup/optimization | Status: closed
Component: Documentation | Version: 1.9
Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by Tim Graham <timograham@…>):

* status: assigned => closed
* resolution: => fixed


Comment:

In [changeset:"2c90981c5f06c0cb3d7a438dd9454ec94fefae17" 2c90981]:
{{{
#!CommitTicketReference repository=""
revision="2c90981c5f06c0cb3d7a438dd9454ec94fefae17"
Fixed #26699 -- Mentioned doc theming difference (locally-built vs.
website).
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/26699#comment:5>

Reply all
Reply to author
Forward
0 new messages