Opened 6 months ago

Closed 6 months ago

Last modified 6 months ago

#36227 closed Bug (fixed)

Outdated gin/gist links to Postgres documentation

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

Description

In the paragraph in the latest (and earlier) docs:

https://docs.djangoproject.com/en/dev/ref/contrib/postgres/indexes/#django.contrib.postgres.indexes.GinIndex

the built-in operator classes reference points at

https://www.postgresql.org/docs/current/gin-builtin-opclasses.html

But the Postgres docs have been reorganised and this link gives "Page not found"

I suggest the following new url, but please check me.

https://www.postgresql.org/docs/17/gin.html#GIN-BUILTIN-OPCLASSES

Whether you replace 17 with current depends on how much you think the structure of the PG docs will change.

There are likely to be similar dangling references around this area

Change History (10)

comment:2 by hesham hatem, 6 months ago

Owner: set to hesham hatem
Status: newassigned

comment:3 by hesham hatem, 6 months ago

I have submitted a PR https://github.com/django/django/pull/19223 with the changes, and I am looking forward to your feedback.

Last edited 6 months ago by hesham hatem (previous) (diff)

comment:4 by hesham hatem, 6 months ago

Has patch: set

comment:5 by Sarah Boyce, 6 months ago

Patch needs improvement: set

comment:6 by hesham hatem, 6 months ago

I finished the latest changes and checked for any outdated links but didn’t find any

comment:7 by Sarah Boyce, 6 months ago

Patch needs improvement: unset
Triage Stage: AcceptedReady for checkin

comment:8 by Sarah Boyce <42296566+sarahboyce@…>, 6 months ago

Resolution: fixed
Status: assignedclosed

In 3ecaa85:

Fixed #36227 -- Fixed outdated PostgreSQL documentation links.

comment:9 by Sarah Boyce <42296566+sarahboyce@…>, 6 months ago

In b280175:

[5.2.x] Fixed #36227 -- Fixed outdated PostgreSQL documentation links.

Backport of 3ecaa85a247373d7ccbcdd593b3fd4bb701f7674 from main.

comment:10 by Sarah Boyce <42296566+sarahboyce@…>, 6 months ago

In dbd94e7a:

[5.1.x] Fixed #36227 -- Fixed outdated PostgreSQL documentation links.

Backport of 3ecaa85a247373d7ccbcdd593b3fd4bb701f7674 from main.

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