MoodleDocs version grouping

MoodleDocs version grouping

by Arjan de Wit -
Number of replies: 10

My name is Arjan de Wit and I'm working as an IT documentation employee at a Dutch software company. We use the Moodle system for our e-learning purposes, but I have a question about the Moodle docs website, which is not related to the Moodle system itself. I'm not sure if someone can help me with this or if this is the right place to ask, but hopefully you can point me in the right direction.

At our company we are using a Mediawiki website for documenting our software. Right now, I am trying to find a solution to restructure the Wiki in a similar way to the Moodle docs pages. Our customers can have different versions of our software and I am wondering how we could structure the Wiki in a way that pages can be related to a certain software version. Thus giving customers the possibility to choose a certain version and thereby showing only relevant pages to that version.

I have searched every possible Mediawiki related page, but it seems Moodle Docs is the only place that has it structured like this. Is there some mediawiki extension used at docs.moodle.org? Or did the developers program this structure themselves? And how does this work in practice? How do you add articles to a certain version of Moodle? I suppose some kind of Categories?

Any suggestion or idea is welcome!

Average of ratings: -
In reply to Arjan de Wit

Re: MoodleDocs version grouping

by Mary Cooch -
Picture of Documentation writers Picture of Moodle HQ Picture of Particularly helpful Moodlers Picture of Testers Picture of Translators

Each time we have a new version the previous wiki is cloned to make the new one -does this page in the developer documentation help? http://docs.moodle.org/dev/New_docs_version_process

Average of ratings: Useful (1)
In reply to Mary Cooch

Re: MoodleDocs version grouping

by Arjan de Wit -

Wow, that is really helpful! Now you've shown the way, it is actually pretty straight forward, cloning the database and changing all relevant pages... did not thought of it myself wink.. time to make some changes at our wiki.

Thanks so much for your quick reply!

Arjan

In reply to Arjan de Wit

Re: MoodleDocs version grouping

by Séverin TERRIER -
Picture of Documentation writers Picture of Particularly helpful Moodlers Picture of Testers Picture of Translators

The counterpart being that if/when something needs to be ammended/corrected, you have to (manually) do it in several wikis.

Take time to think about that...

Average of ratings: Useful (1)
In reply to Séverin TERRIER

Re: MoodleDocs version grouping

by Mary Cooch -
Picture of Documentation writers Picture of Moodle HQ Picture of Particularly helpful Moodlers Picture of Testers Picture of Translators

Yes Séverin - although in the English speaking documentation we only amend the current and the previous versions (so 2.7 and 2.6 at the moment)

Average of ratings: Useful (1)
In reply to Mary Cooch

Re: MoodleDocs version grouping

by Visvanath Ratnaweera -
Picture of Particularly helpful Moodlers Picture of Translators
Mary

You said:
> we only amend the current and the previous versions (so 2.7 and 2.6 at the moment)

That is news to me. I though you would back port ammendments to any previous wiki. (From memory, can't find the forum post.)

@Arjan
You might want to look at this discussion https://moodle.org/mod/forum/discuss.php?d=193518, and many similar ones, before making the decision.
In reply to Visvanath Ratnaweera

Re: MoodleDocs version grouping

by Mary Cooch -
Picture of Documentation writers Picture of Moodle HQ Picture of Particularly helpful Moodlers Picture of Testers Picture of Translators

Visvanath - if I recall correctly I said to you personally I'd paste in any  edits of yours that you wanted to go into earlier versions, but as a  rule we only add to the current and previous  documentation.

In reply to Mary Cooch

This forum post has been removed

The content of this forum post has been removed and can no longer be accessed.
In reply to Deleted user

Re: MoodleDocs version grouping

by Robert Brenstein -
You could simply insert a comment in the older docs to see the docs for 2.7 for more up-to-date information.
In reply to Deleted user

Re: MoodleDocs version grouping

by Mary Cooch -
Picture of Documentation writers Picture of Moodle HQ Picture of Particularly helpful Moodlers Picture of Testers Picture of Translators

Hello both. We only actively maintain the docs for the current version and previous version -so at the moment that is 2.8 and 2.7, although of course people are welcome to add to earlier versions. With respect to Robert's comment, if you access any page of an earlier version - so for example if you go to https://docs.moodle.org/22/en/Calculated_question_type you can see there is a  note advising you to go to the most up to date version. Hopefully this might help?