Opened 7 years ago

Last modified 14 months ago

#28592 new Cleanup/optimization

Reorganize CSRF documentation and add to FAQs

Reported by: Daniele Procida Owned by: Samith Karunathilake
Component: Documentation Version: 1.11
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: no UI/UX: no

Description (last modified by Tim Graham)

The CSRF documentation can be improved.

It currently mixes up topic, reference, and how-to material all in the same document.

The CSRF sections can be expanded to address some common questions about the way Django does this.

​PR

Change History (21)

comment:1 by Daniele Procida, 7 years ago

Owner: changed from nobody to Daniele Procida
Status: new → assigned

comment:2 by Tim Graham, 7 years ago

Description: modified (diff)
Patch needs improvement: set
Summary: Security documentation updates → Reorganize CSRF documentation and add to FAQs
Triage Stage: Unreviewed → Accepted

comment:3 by Jacob Walls, 3 years ago

Patch needs improvement: unset

Hello from the future, Daniele. Found this PR while surfing GitHub. I'm resetting the review flag since it looks like you're caught up on feedback.
​PR

comment:4 by Mariusz Felisiak, 3 years ago

Patch needs improvement: set

This patch is not mergeable anymore. It has a lot of conflicts with the current master, it seems that a new PR is needed to move it forward.

comment:5 by David Smith, 3 years ago

Easy pickings: set

comment:6 by David Smith, 3 years ago

Owner: Daniele Procida removed
Status: assigned → new

comment:7 by Mariusz Felisiak, 3 years ago

David, I have doubts that refactoring a security-related docs is "easy picking".

comment:8 by David Smith, 3 years ago

Hi Mariusz -- you could well be right here, this is certainly not a ticket suited for a beginner.

My thinking was that if a knowledgeable professional comes to look at this, they may find it "easier" as there is prior work here that's already had some reviews. It therefore could "easier" (but by no means easy!) than starting from a scratch.

comment:9 by Jacob Walls, 3 years ago

Owner: set to Tomas McNamer
Patch needs improvement: unset
Status: new → assigned

​New PR. Tomas, could you add Daniele as a ​co-author?

comment:10 by Mariusz Felisiak, 2 years ago

Patch needs improvement: set

comment:11 by GitHub <noreply@…>, 2 years ago

In 65ac1431:

Refs #28592 -- Removed redundant spaces in docs/ref/csrf.txt.

comment:12 by Mariusz Felisiak <felisiak.mariusz@…>, 2 years ago

In e458abc5:

Refs #28592 -- Created a new CSRF how-to document.

comment:13 by GitHub <noreply@…>, 2 years ago

In f77216b:

Refs #28592 -- Improved some headings in CSRF how-to.

comment:14 by Mariusz Felisiak, 2 years ago

Tomas, Do you have time to keep working on this?

comment:15 by Mariusz Felisiak, 15 months ago

Owner: Tomas McNamer removed
Status: assigned → new

comment:16 by madhuri2, 15 months ago

May I know if this ticket is closed? If not closed can I work on it?

Last edited 15 months ago by madhuri2 (previous) (diff)

in reply to:  16 ; comment:17 by Mariusz Felisiak, 15 months ago

Replying to madhuri2:

May I know if this ticket is closed?

No.

If not closed can I work on it?

Sure, feel-free.

in reply to:  17 comment:18 by madhuri2, 15 months ago

okay

comment:19 by Samith Karunathilake, 14 months ago

Owner: set to Samith Karunathilake
Status: new → assigned

comment:20 by Shiwei Chen, 14 months ago

Resolution: → fixed
Status: assigned → closed

CSRF Documentation was updated and the results were successfully merged as of March 2022, as seen in this thread: ​https://github.com/django/django/pull/14956

comment:21 by Tim Graham, 14 months ago

Easy pickings: unset
Resolution: fixed
Status: closed → new

Not all the work is merged, that's why the ticket was left open.

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