Table of contents

Process flow #

  1. Check in Keys Support before adding the Installation Guide link in Magento
    1. Go to Keys Support > Installations
    2. Verify if an Installation Guide exists by searching it using the product name or part of the product name in the search field box.
    3. If there’s an existing Installation Guide, open it by clicking the said Installation Guide and check if the contents are correct and updated.
    4. If none found on the search results, proceed on creating a new Installation Guide based on the copy provided by Dan.
  1. Confirm Product Association
    1. If an Installation Guide is available, ensure that the specific Product SKU is listed under it. To do this, go to the bottom part of the Installation Guide content and see the list of SKUs under the Product SKUs section (see image below).
  1. If the specific SKU is not included, add the SKU by clicking the “Add another” button.
  1. Test the Installation Guide Link
    1. Make sure that the Installation Guide link is working correctly and directs to the correct file. The standard URL format for the Installation Guide Link must follow this:

https://devsupport.keys.express/<language code>/installation-guide/?sku=<product sku>

Here’s an example: https://devsupport.keys.express/en/installation-guide/?sku=1511

The language code to use based on a specific language shall be as follows:

Language codeLanguage
enEnglish
deGerman
frFrench
itItalian
pt-ptPortuguese
esSpanish
  1. Open the corresponding URL following the above format of the Installation Guide link to check if it directs to the correct page with the correct content.
  1. Update Magento
    1. Add the verified Installation Guide link to the appropriate product in Magento by adding the URL under the Download Links section. Use the following when adding the link:
NameTypeApplicable Store Views
Installation GuideOrderENGLISH-EU
InstallationsanleitungOrderGERMAN-DE & GERMAN-CH
Guide d’installationOrderFRENCH-FR & FRENCH-CH
Guida d’installazioneOrderITALIAN-IT & ITALIAN-CH
Guia de instalaçãoOrderPORTUG-PT
Guía de InstalaciónOrderSPANISH-ES
  1. Click the “Save” button after adding the link to update Magento.

What are your feelings
Updated on April 16, 2025