[Django] #33842: Add links to github for file paths in the documentation
Django
------------------------------------------------+------------------------
Reporter: rayman1104 | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: dev
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 1
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
------------------------------------------------+------------------------
It's sometimes confusing to see such statements in the
[https://docs.djangoproject.com/en/dev/ref/contrib/admin/#admin-
overriding-templates docs]:
> The admin template files are located in the
**contrib/admin/templates/admin** directory.
Since I don't have such path in my project, I don't know where to go to
find it. Finally, I understood that the Django's source code is meant and
I can find it on github. But it would be more clear if we just had a link
on github there:
> The admin template files are located in the
[https://github.com/django/django/tree/main/django/contrib/admin/templates/admin
django/contrib/admin/templates/admin] directory.
Here is the [https://github.com/django/django/pull/15808 PR].
--
Ticket URL: <https://code.djangoproject.com/ticket/33842>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: rayman1104 | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by rayman1104):
[https://github.com/django/django/pull/15808 PR]
--
Ticket URL: <https://code.djangoproject.com/ticket/33842#comment:1>
Django
-------------------------------------+-------------------------------------
Reporter: rayman1104 | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Old description:
> It's sometimes confusing to see such statements in the
> [https://docs.djangoproject.com/en/dev/ref/contrib/admin/#admin-
> overriding-templates docs]:
>
> > The admin template files are located in the
> **contrib/admin/templates/admin** directory.
>
> Since I don't have such path in my project, I don't know where to go to
> find it. Finally, I understood that the Django's source code is meant and
> I can find it on github. But it would be more clear if we just had a link
> on github there:
>
> > The admin template files are located in the
> [https://github.com/django/django/tree/main/django/contrib/admin/templates/admin
> django/contrib/admin/templates/admin] directory.
>
> Here is the [https://github.com/django/django/pull/15808 PR].
New description:
It's sometimes confusing to see such statements in the
[https://docs.djangoproject.com/en/dev/ref/contrib/admin/#admin-
overriding-templates docs]:
> The admin template files are located in the
**contrib/admin/templates/admin** directory.
Since I don't have such path in my project, I don't know where to go to
find it. Finally, I understood that the Django's source code is meant and
I can find it on github. But it would be more clear if we just had a link
on github there:
> The admin template files are located in the
[https://github.com/django/django/tree/main/django/contrib/admin/templates/admin
django/contrib/admin/templates/admin] directory.
--
--
Ticket URL: <https://code.djangoproject.com/ticket/33842#comment:2>
Django
-------------------------------------+-------------------------------------
Reporter: rayman1104 | Owner:
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* owner: nobody => rayman1104
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/33842#comment:3>
Django
-------------------------------------+-------------------------------------
Type: | Yanbulatov
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* stage: Unreviewed => Accepted
Comment:
OK, [https://github.com/django/django/pull/15808 ticket for existing PR].
It's likely big enough to require one — thanks!
--
Ticket URL: <https://code.djangoproject.com/ticket/33842#comment:4>
Django
-------------------------------------+-------------------------------------
Reporter: Ramil Yanbulatov | Owner: Ramil
Type: | Yanbulatov
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Carlton Gibson):
* needs_better_patch: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/33842#comment:5>
Django
-------------------------------------+-------------------------------------
Reporter: Ramil Yanbulatov | Owner: Ramil
Type: | Yanbulatov
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
| checkin
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Carlton Gibson):
* needs_better_patch: 1 => 0
* stage: Accepted => Ready for checkin
--
Ticket URL: <https://code.djangoproject.com/ticket/33842#comment:6>
Django
-------------------------------------+-------------------------------------
Reporter: Ramil Yanbulatov | Owner: Ramil
Type: | Yanbulatov
Component: Documentation | Version: dev
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Carlton Gibson <carlton.gibson@…>):
In [changeset:"d69959446221981f87226249e56d8cc0956a3950" d6995944]:
{{{
#!CommitTicketReference repository=""
revision="d69959446221981f87226249e56d8cc0956a3950"
Refs #33842 -- Added :ttag: role in translations docs.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/33842#comment:8>
Django
-------------------------------------+-------------------------------------
Reporter: Ramil Yanbulatov | Owner: Ramil
Type: | Yanbulatov
Cleanup/optimization | Status: closed
Component: Documentation | Version: dev
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Carlton Gibson <carlton.gibson@…>):
In [changeset:"cccfb45d0044513f2c632d2a5d5544127d0d019b" cccfb45d]:
{{{
#!CommitTicketReference repository=""
revision="cccfb45d0044513f2c632d2a5d5544127d0d019b"
Refs #33842 -- Removed incorrect :file: role in contrib docs.
The file role is not appropriate for URLs and URL path-components.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/33842#comment:9>
Django
-------------------------------------+-------------------------------------
Reporter: Ramil Yanbulatov | Owner: Ramil
Type: | Yanbulatov
Cleanup/optimization | Status: closed
Component: Documentation | Version: dev
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"c6290bae9da94234091673fa57ea20411325a9e8" c6290bae]:
{{{
#!CommitTicketReference repository=""
revision="c6290bae9da94234091673fa57ea20411325a9e8"
Fixed #33842 -- Used :source: role for links to repo files on GitHub.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/33842#comment:7>