Moodle
  1. Moodle
  2. MDL-28135

Update harcoded links to MoodleDocs to point to correct wiki (2.0, 2.1 and 2.2)

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Blocker Blocker
    • Resolution: Fixed
    • Affects Version/s: 1.9.12, 2.0.3, 2.1, 2.2
    • Fix Version/s: 2.0.4, 2.1.1
    • Component/s: Installation
    • Labels:
    • Rank:
      17753

      Description

      While installing Moodle 1.9, link on "Current release information" for Release notes point to http://docs.moodle.org/en/Release_Notes, which redirects to 2.0 release notes.

      Release link is hard-coded in code.

      $releasenoteslink = get_string('releasenoteslink', 'admin', 'http://docs.moodle.org/en/Release_Notes');
      

      It will be nice to grep all hard-coded strings and replace them with correct doc link, as part of this fix

      Please check links while updating 1.9 to 2.0 and 2.0 to 2.1, links on "Current release information" for "Server Check" point to previous version docs.

        Issue Links

          Activity

          Hide
          Michael de Raadt added a comment -

          This docs link will redirect to the ''latest'' version. I suspect it is easier to have this generic link before a version is programmatically available. At what stage of the install was this appearing?

          Apart from that, the release notes are now on the Dev docs, so it should be pointing to...

          http://docs.moodle.org/dev/Latest_release_notes

          Show
          Michael de Raadt added a comment - This docs link will redirect to the ''latest'' version. I suspect it is easier to have this generic link before a version is programmatically available. At what stage of the install was this appearing? Apart from that, the release notes are now on the Dev docs, so it should be pointing to... http://docs.moodle.org/dev/Latest_release_notes
          Hide
          Michael de Raadt added a comment -

          I've updated the redirect at http://docs.moodle.org/en/Release_Notes to point to the latest docs.

          Of course, we can still have a discussion about directing to the version specific release notes.

          Show
          Michael de Raadt added a comment - I've updated the redirect at http://docs.moodle.org/en/Release_Notes to point to the latest docs. Of course, we can still have a discussion about directing to the version specific release notes.
          Hide
          Rajesh Taneja added a comment - - edited

          This appears when upgrade starts or installation/upgrade finishes.
          Latest doc link will work good for latest version, but If user installs 1.9 or 2.0, should they be pointed to 2.1/latest release notes?

          Show
          Rajesh Taneja added a comment - - edited This appears when upgrade starts or installation/upgrade finishes. Latest doc link will work good for latest version, but If user installs 1.9 or 2.0, should they be pointed to 2.1/latest release notes?
          Hide
          Eloy Lafuente (stronk7) added a comment - - edited

          we are about to introduce one constant to address this and all the rest of links to docs issues, so this will be able to point to any URL having the 19, 20, 21 string within it.

          So surely, at the end, we'll point to:

          http://docs.moodle.org/XX/en/Release_Notes (with XX being the constant)

          And the wiki-redirect will do its job if the page exists, else latest will be shown (apache redirects in action). Sounds ok?

          Show
          Eloy Lafuente (stronk7) added a comment - - edited we are about to introduce one constant to address this and all the rest of links to docs issues, so this will be able to point to any URL having the 19, 20, 21 string within it. So surely, at the end, we'll point to: http://docs.moodle.org/XX/en/Release_Notes (with XX being the constant) And the wiki-redirect will do its job if the page exists, else latest will be shown (apache redirects in action). Sounds ok?
          Hide
          Martin Dougiamas added a comment -

          Please just leave it hardcoded, and point it to http://docs.moodle.org/dev/Releases

          That page will be the starting point for all release information and will give the proper context.

          Show
          Martin Dougiamas added a comment - Please just leave it hardcoded, and point it to http://docs.moodle.org/dev/Releases That page will be the starting point for all release information and will give the proper context.
          Hide
          Eloy Lafuente (stronk7) added a comment -

          wtf means the proper context? LOL. And my beloved "es" release notes I've been maintaining since 1.0.1 ? (just an example).

          Show
          Eloy Lafuente (stronk7) added a comment - wtf means the proper context? LOL. And my beloved "es" release notes I've been maintaining since 1.0.1 ? (just an example).
          Hide
          Martin Dougiamas added a comment -

          By context I mean, if you are upgrading from 1.9 to 2.1.1, you probably want to see more than just the release notes for 2.1.1. Right?

          As for translations, it's very cool you've been translating to ES but that is highly manual and prone to failure, since there is no process in place for anyone to keep those 100% in sync. So I think for release notes we should focus on

          1) A 100% accurate English version with full details, technical language.
          2) Summaries only in the various versioned wiki documents. ie a "What's new in 2.1" section in the User docs.

          Show
          Martin Dougiamas added a comment - By context I mean, if you are upgrading from 1.9 to 2.1.1, you probably want to see more than just the release notes for 2.1.1. Right? As for translations, it's very cool you've been translating to ES but that is highly manual and prone to failure, since there is no process in place for anyone to keep those 100% in sync. So I think for release notes we should focus on 1) A 100% accurate English version with full details, technical language. 2) Summaries only in the various versioned wiki documents. ie a "What's new in 2.1" section in the User docs.
          Hide
          Martin Dougiamas added a comment -

          Marking blocker to get it in the scrum next week and closed.

          Show
          Martin Dougiamas added a comment - Marking blocker to get it in the scrum next week and closed.
          Hide
          Aparup Banerjee added a comment -

          i've noticed that in 2.x theres alot of links (even in comments) that really need to be updated. i've started replacing them (first in master) @ https://github.com/nebgor/moodle/compare/mistress...MDL-28135

          Show
          Aparup Banerjee added a comment - i've noticed that in 2.x theres alot of links (even in comments) that really need to be updated. i've started replacing them (first in master) @ https://github.com/nebgor/moodle/compare/mistress...MDL-28135
          Hide
          Aparup Banerjee added a comment - - edited

          changes to URLs done.

          docs urls were tested with

          grep -Rh 'docs.moodle.org/' . | grep -o http:\/\/docs\.moodle\.org\/[a-zA-Z0-9_/:.#-]* | sort -u - | wget -i- -S  -O /dev/null -o testurls.log 
          
          grep -B4 'HTTP\/.* 404' testurls.log 
          

          The following will have to be resolved (Petr said he would get around to resolving this doc page):
          ./lib/outputfactories.php:22: * Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML
          ./lib/outputcomponents.php:21: * Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML
          ./lib/outputrenderers.php:21: * Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML
          ./lib/outputactions.php:21: * Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML
          ./lib/outputlib.php:21: * Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML
          ./theme/standardold/config.php:29: * http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML

          Theres some confusion about these urls:
          ./lib/pagelib.php:1880: // http://docs.moodle.org/dev/Migrating_your_code_code_to_the_2.0_rendering_API

          i'll now make similar changes to other branches now based on https://github.com/nebgor/moodle/compare/mistress...MDL-28135

          Show
          Aparup Banerjee added a comment - - edited changes to URLs done. docs urls were tested with grep -Rh 'docs.moodle.org/' . | grep -o http:\/\/docs\.moodle\.org\/[a-zA-Z0-9_/:.#-]* | sort -u - | wget -i- -S -O /dev/ null -o testurls.log grep -B4 'HTTP\/.* 404' testurls.log The following will have to be resolved (Petr said he would get around to resolving this doc page): ./lib/outputfactories.php:22: * Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML ./lib/outputcomponents.php:21: * Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML ./lib/outputrenderers.php:21: * Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML ./lib/outputactions.php:21: * Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML ./lib/outputlib.php:21: * Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML ./theme/standardold/config.php:29: * http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML Theres some confusion about these urls: ./lib/pagelib.php:1880: // http://docs.moodle.org/dev/Migrating_your_code_code_to_the_2.0_rendering_API http://docs.moodle.org/20/en/Obsolete_talk:Migrating_your_code_to_the_2.0_rendering_API i'll now make similar changes to other branches now based on https://github.com/nebgor/moodle/compare/mistress...MDL-28135
          Hide
          Aparup Banerjee added a comment -

          hows this looking? the $branch thing should be handled in MDL-28134

          Show
          Aparup Banerjee added a comment - hows this looking? the $branch thing should be handled in MDL-28134
          Hide
          Sam Hemelryk added a comment -

          Hi Apu,

          Are there a branch with changes for 1.9 as well? or was it discussed and decided to leave the links in Moodle 1.9?

          Cheers
          Sam

          Show
          Sam Hemelryk added a comment - Hi Apu, Are there a branch with changes for 1.9 as well? or was it discussed and decided to leave the links in Moodle 1.9? Cheers Sam
          Hide
          Aparup Banerjee added a comment -

          doh. i had started a m19 branch with changes on my machine (not pushed - as they weren't all tested yet). i'll get it done in MDL-28209

          Thanks Sam!

          Show
          Aparup Banerjee added a comment - doh. i had started a m19 branch with changes on my machine (not pushed - as they weren't all tested yet). i'll get it done in MDL-28209 Thanks Sam!
          Hide
          Sam Hemelryk added a comment -

          No probs thanks Apu - this has been integrated now.

          Show
          Sam Hemelryk added a comment - No probs thanks Apu - this has been integrated now.
          Hide
          Eloy Lafuente (stronk7) added a comment -

          Ho, guys, side but important comment... I just got changes from integration.git and saw all the install/lang/xxx/xxxx files updated!

          And all those files are 100% maintained by AMOS, funny the change you performed was exactly in the middle of the comment saying "Do not edit this file manually!" LOL.

          So they should never be integrated this way (we pick them from AMOS weekly instead). So next time, plz, ask David if there is something to change.

          I've requested him to update all the AMOS-generated files to make them match and avoid getting conflicts and so on (and he's going to try it). But plz, be noted this should not happen again. No worries, just FYI!

          Ciao

          Show
          Eloy Lafuente (stronk7) added a comment - Ho, guys, side but important comment... I just got changes from integration.git and saw all the install/lang/xxx/xxxx files updated! And all those files are 100% maintained by AMOS, funny the change you performed was exactly in the middle of the comment saying "Do not edit this file manually!" LOL. So they should never be integrated this way (we pick them from AMOS weekly instead). So next time, plz, ask David if there is something to change. I've requested him to update all the AMOS-generated files to make them match and avoid getting conflicts and so on (and he's going to try it). But plz, be noted this should not happen again. No worries, just FYI! Ciao
          Hide
          Aparup Banerjee added a comment - - edited

          doh! AMOS generated lang packs noted!

          ps: on that note, maybe we should change default file permissions for generated files to read only (for git)?

          Show
          Aparup Banerjee added a comment - - edited doh! AMOS generated lang packs noted! ps: on that note, maybe we should change default file permissions for generated files to read only (for git)?
          Hide
          Sam Hemelryk added a comment -

          My bad sorry - I should've spotted that. Do we need to revert the changes Eloy or am I correct in thinking that AMOS is going to overwrite them anyway?

          Cheers
          Sam

          Show
          Sam Hemelryk added a comment - My bad sorry - I should've spotted that. Do we need to revert the changes Eloy or am I correct in thinking that AMOS is going to overwrite them anyway? Cheers Sam
          Hide
          Andrew Davis added a comment - - edited

          I don't think the docs links are working quite right. If I go into a forum (/mod/forum/view.php?id=2) and hover over the Moodle docs link the URL is http://docs.moodle.org/22/en/mod/forum/view.

          When I click on it I get a page saying I'm being redirected to the English version of the Moodle docs and then I'm sent to http://docs.moodle.org/20/en/Main_Page

          The forum does have a doc that I could be sent to http://docs.moodle.org/20/en/Forum_module

          Is that related to this issue or is that an unrelated piece of brokenness?

          Show
          Andrew Davis added a comment - - edited I don't think the docs links are working quite right. If I go into a forum (/mod/forum/view.php?id=2) and hover over the Moodle docs link the URL is http://docs.moodle.org/22/en/mod/forum/view . When I click on it I get a page saying I'm being redirected to the English version of the Moodle docs and then I'm sent to http://docs.moodle.org/20/en/Main_Page The forum does have a doc that I could be sent to http://docs.moodle.org/20/en/Forum_module Is that related to this issue or is that an unrelated piece of brokenness?
          Hide
          Aparup Banerjee added a comment -

          That url structure does appear to be right. There should be a page at that url: http://docs.moodle.org/22/en/mod/forum/view. maybe some redirections aren't working right in docs.moodle.org

          Show
          Aparup Banerjee added a comment - That url structure does appear to be right. There should be a page at that url: http://docs.moodle.org/22/en/mod/forum/view . maybe some redirections aren't working right in docs.moodle.org
          Hide
          Andrew Davis added a comment -

          Ive tested this in 2.0 stable by running Aparup's script and by also clicking around at random. The script says everything is fine and the links in 2.0 stable all seem to go somewhere sensible. It just looks like docs itself is busted as far as the current master version of Moodle is concerned. This can be passed but I no longer have the buttons available in tracker to pass it.

          Show
          Andrew Davis added a comment - Ive tested this in 2.0 stable by running Aparup's script and by also clicking around at random. The script says everything is fine and the links in 2.0 stable all seem to go somewhere sensible. It just looks like docs itself is busted as far as the current master version of Moodle is concerned. This can be passed but I no longer have the buttons available in tracker to pass it.
          Hide
          Eloy Lafuente (stronk7) added a comment -

          I'd feel inclined to say that those links for 2.2 are correct, another thing is if the docs server is ready to accept them or no and should fallback to something better or no.

          In any case, plz, decide if this is really a fail on not ASAP, we should be pushing to moodle.git in <24h.

          Show
          Eloy Lafuente (stronk7) added a comment - I'd feel inclined to say that those links for 2.2 are correct, another thing is if the docs server is ready to accept them or no and should fallback to something better or no. In any case, plz, decide if this is really a fail on not ASAP, we should be pushing to moodle.git in <24h.
          Hide
          Eloy Lafuente (stronk7) added a comment -

          I've changed a bit the title of the issue to better represent what is being fixed (keeping the 1.9 stuff out for the new issue). Feel free to amend it if necessary. Ciao

          Show
          Eloy Lafuente (stronk7) added a comment - I've changed a bit the title of the issue to better represent what is being fixed (keeping the 1.9 stuff out for the new issue). Feel free to amend it if necessary. Ciao
          Hide
          Sam Hemelryk added a comment -

          Reseting for testing again

          Show
          Sam Hemelryk added a comment - Reseting for testing again
          Hide
          Andrew Davis added a comment -

          Looks like the code is fine but the docs server isn't quite right. passing this.

          Show
          Andrew Davis added a comment - Looks like the code is fine but the docs server isn't quite right. passing this.
          Hide
          Eloy Lafuente (stronk7) added a comment -

          Moodle's git/cvs repositories have been updated with this piece of art! Thanks!

          Show
          Eloy Lafuente (stronk7) added a comment - Moodle's git/cvs repositories have been updated with this piece of art! Thanks!

            People

            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: