tutorial
tutorial copied to clipboard
DjangoGirls
Searching in the tutorial is inconvenient
It happens many times during the workshop that a participant or a coach wants to run a command again, but they don't remember the exact command, so they want to search for it in the tutorial. But they don't remember which page has mentioned the command, so they have to run the local find operation on all pages manually. This is inconvenient, frustrating and error-prone.
My recommendation: Add single-page view to the tutorial, which contains all pages with everything expanded.
A search mechanism would be an improvement, but for me, it would be less convenient than the single-page view. In-page search (Ctrl-F) shows much more useful context, and it's always up-to-date. It also easier to implement and maintain.
I've just checked - there's a search box in the tutorial already! In case you also missed it - it's in the top left corner of the page.
If you still prefer to search for things using ctrl+f, you can download the tutorial on your computer as pdf from here: https://www.gitbook.com/book/djangogirls/djangogirls-tutorial/details Would that make things easier?
The search functionality in the top left corner is useless for me. Try to search for git push. It shows 5 pages, and the snippets are irrelevant. Then try to search for "git push". It shows no results. There is a relevant result on the Deploy! page.
The PDF download link is a useful workaround, Ctrl-F in the PDF works well for me. If it's too much work now to add a single-page HTML view, then the PDF download link should be advertised in the tutorial.