-
Notifications
You must be signed in to change notification settings - Fork 229
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Tutorial Lengths & Translations #779
Comments
Capping at 8,000 words sounds sensible to me. |
related to #681 |
I would like to add this to our current documentation so that authors can begin to follow it. If you would like to raise any concerns, please do so by 7 May 2018, at which point I"m going to add a pull request. |
As I mentioned on the call, I think this is a good suggestion. Particularly since it covers most tutorials that we have already, I think it's a fine approach that would cover us from extreme cases. I'd just want to make sure that the language for this indicates that while 8000 words is the upper limit we encourage and frequently publish shorter lessons. |
I like it as long as it is clear that it is an approximation (do you say that in English?), upper limit as @walshbr points to, and that we are happy to create a series of tutorials on a topic that needs more length (like the tutorials on Python and on Geospatial analysis). |
This involves changing the same files as being amended in #651 so I will adjust that once the first ticket has been closed. |
This has been closed via #830 pull request. |
* word limit and clearer proposal guidelines issues #751 and #779 Also removed some superfluous "!" * update funding declaration issue #833 * add link to NiCHE website in funding declaration * add h2 to funding header * translate heather's bio into spa (#831) * Check for presence of `review-ticket` in lesson YAML (#816) * Check for presence of `review-ticket` in lesson YAML * convert standalone review ticket numbers to urls * add review ticket number * add review ticket number * add review ticket number * add review ticket number * add review ticket number * add review ticket number * add review ticket number * add review ticket number * add review ticket number * add review ticket number * added review ticket number * added review ticket number * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * review-ticket: NULL * pull request URL * pull request url * exclude oldest lessons from having a review ticket These lessons were written before PH formalized a review system that used GitHub tickets * switch bare digit review-ticket to full url * add review ticket link * add review ticket link * add review ticket * add review ticket * add review ticket * add review ticket * Update escritura-sostenible-usando-pandoc-y-markdown.md * add review ticket * add review ticket * add review ticket * add review ticket * Update intro-a-google-maps-y-google-earth.md * add review ticket * add review ticket * Update introduccion-control-versiones-github-desktop.md * add review ticket * add review ticket * add review ticket * add review ticket * add review ticket * Update palabras-clave-en-contexto-n-grams.md * add review ticket * add review ticket * add review ticket * add review ticket * add review ticket * Update sparql-datos-abiertos-enlazados.md * add review ticket * add review ticket * add review ticket * fix two remaining lessons * add basic peer review link when one exists for a lesson * link to font-awesome CDN rather than need to host ourselves * Use font-aewsome glyph for peer review * fix review tickets that got missed during regex * Use snippets for peer-review text * use CC-BY link in header too * style peer review and cc icons to appear side by side * darken default text for peer-review/license in lesson header * add new translation on antconc * add second reviewer * add original * fix link to images * Update guia-para-autores.md * Update guia-para-autores.md * Update references to font awesome (#842) * moved english structural files + lessons to /en * Fixed GitHub Icon (#845) GitHub icon was rendering as a block because the naming in Font Awesome 5 was slightly different. https://fontawesome.com/icons/github?style=brands There is not an icon associated with `fa fa-github` in Font Awesome 5 but there is an icon associated with`fab fa-github`. It appears the former was supported in Font Awesome 4 but Programming Historian is now running on Font Awesome 5. * fix 27 link errors as per Travis * Using most recent author-guidelines file * Add files via upload * add links to wiki and more verbose. as per issue #847 * un-link dead links * remove absolute links to english lessons * remove absolute links to spanish lessons * use en in example URLs bearing full path * ensure old github migration post points to oldsite repo * correct urls in author guidelines * wrap es author guide link in backticks Keeps it from being treated erroneously as a real URL * Use liveurl Changing this config variable name prevents the redirect_from plugin from creating absolute URL redirects that point to the live site. * Refactor scope variables Now that there is an en/ directory we need to define its scope explicitly in _config * replace broken gdw-berlin PDF link with wayback * remove remaining absolute links where I can find them * update funding declaration issue #833 * add link to NiCHE website in funding declaration * add h2 to funding header
@arojascastro has pointed out that longer tutorials take more work to translate #751 . If we move to paid copy editing, longer lessons will also incur a greater cost (£).
@drjwbaker noted there wasn't a clear pedagogical reason for restricting tutorial lengths, but the above reasons may be good enough for encouraging a maximum word length. In particular, our current translations have (understandably) focused on the shorter tutorials:
Over time, our lessons have become considerably longer, and not necessarily at the benefit of increased traffic (not that traffic is the only measure of success worth noting):
Y axis is word length; x asis is year published; size is traffic past 12 months.
It seems that there may be good colleagial and financial reasons for capping submissions to less than 8,000 words? This is still quite long, and in line with many other journals in history.
The text was updated successfully, but these errors were encountered: