Re: [Django] #25703: Create topic documentation for Expressions

[Django]

#25703: Create topic documentation for Expressions
--+
 Reporter:  Mikey Ariel   |Owner:  (none)
 Type:  Cleanup/optimization  |   Status:  new
Component:  Documentation |  Version:  dev
 Severity:  Normal|   Resolution:
 Keywords:| Triage Stage:  Accepted
Has patch:  0 |  Needs documentation:  0
  Needs tests:  0 |  Patch needs improvement:  0
Easy pickings:  0 |UI/UX:  0
--+
Changes (by Ülgen Sarıkavak):

 * cc: Ülgen Sarıkavak (added)

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/0107018e50692c01-2c788a5f-a54a-4923-b1d2-bfd3a03595ec-00%40eu-central-1.amazonses.com.

Re: [Django] #25703: Create topic documentation for Expressions

[Django]

#25703: Create topic documentation for Expressions
--+
 Reporter:  Mikey Ariel   |Owner:  (none)
 Type:  Cleanup/optimization  |   Status:  new
Component:  Documentation |  Version:  master
 Severity:  Normal|   Resolution:
 Keywords:| Triage Stage:  Accepted
Has patch:  0 |  Needs documentation:  0
  Needs tests:  0 |  Patch needs improvement:  0
Easy pickings:  0 |UI/UX:  0
--+
Changes (by felixxm):

 * owner:  Mikey Ariel => (none)
 * status:  assigned => new


-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/070.da16e456e788387d4273f3f8ad2ea330%40djangoproject.com.

Re: [Django] #25703: Create topic documentation for Expressions

[Django]

#25703: Create topic documentation for Expressions
-+-
 Reporter:  thatdocslady |Owner:
 Type:   |  thatdocslady
  Cleanup/optimization   |   Status:  assigned
Component:  Documentation|  Version:  master
 Severity:  Normal   |   Resolution:
 Keywords:   | Triage Stage:  Accepted
Has patch:  0|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  0
Easy pickings:  0|UI/UX:  0
-+-

Comment (by thatdocslady):

 Replying to [comment:7 jarshwah]:
 > Sorry, I haven't had a chance to do very much here.

 You and me both ;) turns out I need to catch up on my ORM lore before I
 can tackle this content, but I started researching and will ping you again
 soon with NEEDINFO as needed. Cheers!

--
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/070.430c85bc51516b4166d6cd1e47914bf4%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #25703: Create topic documentation for Expressions

[Django]

#25703: Create topic documentation for Expressions
-+-
 Reporter:  thatdocslady |Owner:
 Type:   |  thatdocslady
  Cleanup/optimization   |   Status:  assigned
Component:  Documentation|  Version:  master
 Severity:  Normal   |   Resolution:
 Keywords:   | Triage Stage:  Accepted
Has patch:  0|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  0
Easy pickings:  0|UI/UX:  0
-+-

Comment (by jarshwah):

 Sorry, I haven't had a chance to do very much here. I started writing code
 with some comments the other day that I'd planned to circle back to and
 write some prose for. Apparently jetlag is a thing though. See attached
 what I started with. Hopefully there are some knowledgeable django people
 at the sprints that can help out.

 Here's where I got to:
 
https://github.com/jarshwah/expressions_talk/blob/topicdoc/expressions/topicdoc/models.py

 Not sure how helpful that's going to be on it's own unfortunately.

--
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/070.9e0b01752687276d2803a305fab34f6c%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #25703: Create topic documentation for Expressions

[Django]

#25703: Create topic documentation for Expressions
-+-
 Reporter:  thatdocslady |Owner:
 Type:   |  thatdocslady
  Cleanup/optimization   |   Status:  assigned
Component:  Documentation|  Version:  master
 Severity:  Normal   |   Resolution:
 Keywords:   | Triage Stage:  Accepted
Has patch:  0|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  0
Easy pickings:  0|UI/UX:  0
-+-

Comment (by thatdocslady):

 Replying to [comment:5 jarshwah]:
 > I'll try and put something together by then. What exactly are you after?
 Use cases, API usage, and SQL (your point 2 above)? What else can help?

 Great, thanks! Other than what you mentioned, it might help to have
 links/references to existing basic SQL docs so that I can do a comparison
 and build an "upsell" for the extended functionality.

--
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/070.c63fa09b3a26dfa23a89caf3510810b8%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #25703: Create topic documentation for Expressions

[Django]

#25703: Create topic documentation for Expressions
-+-
 Reporter:  thatdocslady |Owner:
 Type:   |  thatdocslady
  Cleanup/optimization   |   Status:  assigned
Component:  Documentation|  Version:  master
 Severity:  Normal   |   Resolution:
 Keywords:   | Triage Stage:  Accepted
Has patch:  0|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  0
Easy pickings:  0|UI/UX:  0
-+-

Comment (by jarshwah):

 I'll try and put something together by then. What exactly are you after?
 Use cases, API usage, and SQL (your point 2 above)? What else can help?

--
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/070.2b389d53a82385be0408e0d051a57bcc%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #25703: Create topic documentation for Expressions

[Django]

#25703: Create topic documentation for Expressions
-+-
 Reporter:  thatdocslady |Owner:
 Type:   |  thatdocslady
  Cleanup/optimization   |   Status:  assigned
Component:  Documentation|  Version:  master
 Severity:  Normal   |   Resolution:
 Keywords:   | Triage Stage:  Accepted
Has patch:  0|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  0
Easy pickings:  0|UI/UX:  0
-+-

Comment (by thatdocslady):

 Replying to [comment:3 jarshwah]:
 > Thinking about this a little more, I think what we should be writing
 topic docs on is "Customising the SQL generated by the ORM". Topic name to
 be cleaned up.
 >
 > That's really the entire point of expressions. They let you customise
 the query. Lookups and Transforms also help with customising the query.
 Extra and Raw, to a lesser extent, also help with this. I think the topic
 docs should make this as their focus.
 >
 > We can then link to Expressions API docs, Lookup/Transform API docs (of
 which there is already topic docs on how to create your own and why), with
 a light touch on extra/raw.
 >
 > Thoughts?

 That makes absolute sense, actually. Similar to how we expanded the full-
 text search docs to encompass all-things-search, we can approach
 expressions from the functional/user perspective. So something like this:

 1. Custom SQL operations with the ORM (title WIP) - Overview topic that
 builds on the basic SQL topic and tells users what we can offer them to
 extend/customize SQL with the ORM.

 2. One or more use-case examples of expressions + queries to achieve
 specific goals (for example, the reporting you wanted to do). These will
 include scenario>goal>SQL snippet>result, much like a tutorial but
 lighter.

 3. Reference sections for APIs and further reading links as needed.

 How does that sound? I'm planning to sprint on this on Sunday at PyCon CZ,
 so if you can provide some basic/raw data for it by then, I can flesh it
 out and hammer out a draft.

--
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/070.0e873019ceecfcd771adc37ad59942c3%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #25703: Create topic documentation for Expressions

[Django]

#25703: Create topic documentation for Expressions
-+-
 Reporter:  thatdocslady |Owner:
 Type:   |  thatdocslady
  Cleanup/optimization   |   Status:  assigned
Component:  Documentation|  Version:  master
 Severity:  Normal   |   Resolution:
 Keywords:   | Triage Stage:  Accepted
Has patch:  0|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  0
Easy pickings:  0|UI/UX:  0
-+-

Comment (by jarshwah):

 Thinking about this a little more, I think what we should be writing topic
 docs on is "Customising the SQL generated by the ORM". Topic name to be
 cleaned up.

 That's really the entire point of expressions. They let you customise the
 query. Lookups and Transforms also help with customising the query. Extra
 and Raw, to a lesser extent, also help with this. I think the topic docs
 should make this as their focus.

 We can then link to Expressions API docs, Lookup/Transform API docs (of
 which there is already topic docs on how to create your own and why), with
 a light touch on extra/raw.

 Thoughts?

--
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/070.f9c63ba7bd6f1562ea0c704eca2eeacf%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #25703: Create topic documentation for Expressions

[Django]

#25703: Create topic documentation for Expressions
-+-
 Reporter:  thatdocslady |Owner:
 Type:   |  thatdocslady
  Cleanup/optimization   |   Status:  assigned
Component:  Documentation|  Version:  master
 Severity:  Normal   |   Resolution:
 Keywords:   | Triage Stage:  Accepted
Has patch:  0|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  0
Easy pickings:  0|UI/UX:  0
-+-
Changes (by timgraham):

 * stage:  Unreviewed => Accepted


--
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/070.713ba07f9d05827d474cac409dcc39ec%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #25703: Create topic documentation for Expressions

[Django]

#25703: Create topic documentation for Expressions
-+-
 Reporter:  thatdocslady |Owner:
 Type:   |  thatdocslady
  Cleanup/optimization   |   Status:  assigned
Component:  Documentation|  Version:  master
 Severity:  Normal   |   Resolution:
 Keywords:   | Triage Stage:
 |  Unreviewed
Has patch:  0|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  0
Easy pickings:  0|UI/UX:  0
-+-
Changes (by thatdocslady):

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


--
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/070.a25b8be6b27c2734afa91affea6d99b5%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.