search

openedx / edx-documentation

http://docs.edx.org
Other
163 stars 339 forks source link

Might need to edit old doc versions of open edX so it is evident which release they apply to easily.... #1794

Open frohro opened 5 years ago

frohro commented 5 years ago

For example, I was trying to understand better how to build a circuit simulation problem (in my hawthorn installation), and so I copy/pasted the problem at the end of the page here into my course. It won't allow me to save it. I deleted references to files that I don't have in my course, but that made no difference. Then I wondered if it was a release issue, and so I searched specifically for Hawthorn Circuit Schematic Builder problem, and found this page. I tried the example there, and it worked just fine. Then I looked closely and found that if I read the URL carefully, I can tell the original docs were from Birch. Fortunately the new docs have Hawthorn called out prominently. :-)

Thanks for all your good work on these documents! Rob

nedbat commented 5 years ago

@frohro thanks for pointing this out. I don't think we will republish the old docs with new titles, but we might remove the old docs. /cc @grantgoodmanedX opinion?

grantgoodmanedX commented 5 years ago

@nedbat I'd be happy to remove any docs that we don't think people use, or should use. Do you have opinions about how far back we should go? Should we keep latest, most recent release, and release before that? (Which would be Latest, Hawthorn, and Ginkgo?)

frohro commented 5 years ago

Thanks for looking at this. Unfortunately I'm a bit of a newbie on Open edX. I've only been using it last quarter and this one for blended learning classes. Now that I know I need to include Hawthorn in the Google search terms, I'm good, but it took me a full quarter to figure that out. Fortunately things are usually similar between releases. Really it would be nice to know how many are still using the older versions, and I have no real idea on that.

nedbat commented 5 years ago

On second thought, it wouldn't be hard to get the release name in the title....?

grantgoodmanedX commented 5 years ago

We have the release name in the title as far back as the Cypress release. I took the easy way out and made the Birch release doc private, so that should avoid this confusion in the future.