Opened 3 years ago

Closed 3 years ago

#18721 closed Cleanup/optimization (needsinfo)

Documentation Collaboration | Copy Code Button | Tiny Improvements Save Time

Reported by: Quark Owned by: nobody
Component: Documentation Version: 1.4
Severity: Normal Keywords:
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

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.

Change History (1)

comment:1 Changed 3 years ago by timo

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Resolution set to needsinfo
  • Status changed from new to closed

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/
  1. 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.
  1. 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.
Note: See TracTickets for help on using tickets.
Back to Top