[Django] #18721: Documentation Collaboration | Copy Code Button | Tiny Improvements Save Time

9 views

Skip to first unread message

Django

unread,

Aug 5, 2012, 10:01:37 PM8/5/12

to django-...@googlegroups.com

#18721: Documentation Collaboration | Copy Code Button | Tiny Improvements Save
Time
--------------------------------------+--------------------
Reporter: Quark | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 1.4
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+--------------------
Dear Community,

https://docs.djangoproject.com/en/1.4/topics/install/

'''Documentation Collaboration'''
It would be great if the Django student community, could edit the online
documentation collaboratively.
Through source control?

'''Copy Code Button'''
It would save a lot of time, if Django students, could click a Copy Code
Button,
instead of having to highlight and copy.

'''Tiny Improvement'''
On the page listed above, change:

{{{
python -c "from distutils.sysconfig import get_python_lib; print
get_python_lib()"
}}}

to:

{{{
cd `python -c "from distutils.sysconfig import get_python_lib; print
get_python_lib()"`
}}}

All this saves time.

The current steps:

1. Highlight code.
2. Copy text.
3. Fire up terminal.
4. Paste text.
5. Execute code.
6. Type cd <directory>

Steps after optimisation:

1. Click copy button.
2. Fire up terminal.
3. Paste text.
4. Execute code.

If it were possible to trust web page code, the quality plateau, would be:

1. Click execute button (to execute steps 1-4).

If the inefficiency is 20 seconds, and 100,000 people go through these
hoops,
The total time wasted is ~23 days.

Best Wishes,
Quark.

--
Ticket URL: <https://code.djangoproject.com/ticket/18721>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,

Aug 17, 2012, 11:04:45 AM8/17/12

to django-...@googlegroups.com

#18721: Documentation Collaboration | Copy Code Button | Tiny Improvements Save
Time

Easy pickings: 1 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by timo):

* status: new => closed
* needs_better_patch: => 0
* resolution: => needsinfo
* needs_tests: => 0
* needs_docs: => 0

Comment:

Hi Qwark,

Thanks for your feedback!

1. Absolutely -- we accept pull requests from GitHub for documentation
fixes, see https://docs.djangoproject.com/en/dev/internals/contributing
/writing-code/submitting-patches/

2. I'm not sure how we could add a copy code button to our documentation
-- perhaps if you would like to do some research or bring up the idea on
the http://groups.google.com/group/django-developers mailing list, we
could explore it further.

3. I'm not sure why adding cd to the command is needed. The intention is
simply to print the location of site-packages, not change directory to
that location.