Opened 22 months ago

Closed 21 months ago

Last modified 21 months ago

#33842 closed Cleanup/optimization (fixed)

Add links to github for file paths in the documentation

Reported by: Ramil Yanbulatov Owned by: Ramil Yanbulatov
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description (last modified by Ramil Yanbulatov)

It's sometimes confusing to see such statements in the 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 django/contrib/admin/templates/admin directory.

Change History (9)

comment:1 by Ramil Yanbulatov, 22 months ago

comment:2 by Ramil Yanbulatov, 22 months ago

Description: modified (diff)

comment:3 by Ramil Yanbulatov, 22 months ago

Owner: changed from nobody to Ramil Yanbulatov
Status: newassigned

comment:4 by Carlton Gibson, 22 months ago

Triage Stage: UnreviewedAccepted

OK, ticket for existing PR. It's likely big enough to require one — thanks!

comment:5 by Carlton Gibson, 22 months ago

Patch needs improvement: set

comment:6 by Carlton Gibson, 21 months ago

Patch needs improvement: unset
Triage Stage: AcceptedReady for checkin

comment:7 by Carlton Gibson <carlton.gibson@…>, 21 months ago

Resolution: fixed
Status: assignedclosed

In c6290bae:

Fixed #33842 -- Used :source: role for links to repo files on GitHub.

comment:8 by Carlton Gibson <carlton.gibson@…>, 21 months ago

In d6995944:

Refs #33842 -- Added :ttag: role in translations docs.

comment:9 by Carlton Gibson <carlton.gibson@…>, 21 months ago

In cccfb45d:

Refs #33842 -- Removed incorrect :file: role in contrib docs.

The file role is not appropriate for URLs and URL path-components.

Note: See TracTickets for help on using tickets.
Back to Top