-
-
Notifications
You must be signed in to change notification settings - Fork 15
Website 404 Redirection
The standard path format for requesting a documentation page from the website is https://picard-docs.musicbrainz.org/{version}/{language}/{page}
where:
-
{version}
is themajor.minor
form of the desired version number, starting with a 'v'. For example, if you are requesting documentation for release version 2.5.1 (part of the 2.5 family of releases),v2.5
would be entered as the version in the requested URL. If{version}
is omitted, the latest version will be displayed. -
{language}
is the two-character code for the desired language. Currently onlyen
(English) andfr
(French) are supported. -
{page}
is the name of the HTML file to display including the topic path, such asabout_picard/contributing.html
.
If the requested file is not found on the server, a file not found (404) condition will be triggered resulting in the display of an appropriate message. Additional redirection logic has been built into the 404 processing to try to identify and display the requested page before displaying the file not found message. This allows the site to support requests based on the ReadTheDocs format of /{language}/{version}/{page}
where the {version}
does not include the 'v' or can also be either latest
or stable
. The redirection logic will also try to accommodate some missing information by using default values, or information placed in the wrong order.
Some redirection examples include:
Requested | Displayed | Comment |
---|---|---|
/ | /en/index.html | Displays the latest version and tries to match the language to one of the user's preferred languages, defaulting to en if no corresponding match is found in the supported languages list |
/2.5/fr/config/configuration.html | /v2.5/fr/config/configuration.html | Adds the missing 'v' in the version number |
/2.5/config/configuration.html | /v2.5/en/config/configuration.html | Adds the missing 'v' in the version number and uses the default language en
|
/v2.5/it/config/configuration.html | /v2.5/en/config/configuration.html | Replaces the currently unsupported it language with the default en
|
/v2.5.1/config/configuration.html | /v2.5/en/config/configuration.html | Displays the major.minor version of the selected page in the default language en
|
/v2.5.1/fr/config/configuration.html | /v2.5/fr/config/configuration.html | Displays the major.minor version of the selected page |
/it/v2.5/config/configuration.html | /v2.5/en/config/configuration.html | Replaces the currently unsupported it language with the default en and repositions the version number |
/fr/2.5/config/configuration.html | /v2.5/fr/config/configuration.html | Reformat ReadTheDocs-style request |
/fr/2.5.2/config/configuration.html | /v2.5/fr/config/configuration.html | Reformat ReadTheDocs-style request and displays the major.minor version |
/en/2.5/fr/config/configuration.html | /v2.5/fr/config/configuration.html | Reformat improper ReadTheDocs-style request and use the latest language specified before the page information |
The MusicBrainz Picard Documentation Project and the Picard User Guide are licensed under CC0 1.0.