Skip to end of metadata
Go to start of metadata

Contributing to the PrestaShop documentation

Just like PrestaShop itself, this documentation site (and its content) is open to everyone for suggestions, ideas and modifications!

All you need is to have your user-account validated by the administrators, and to follow the guidelines.

Who we need

  • Proofreaders. Mistakes happen! When pages of pages of documentation are being written, there is always a possibility that a typo might be typed, a word forgotten, or a homonym used when it should not be. Even proofreaders might miss mistakes, so the more the merrier! Being an open-source project, we like to keep Linus' Law in effect (read: http://en.wikipedia.org/wiki/Linus%27_Law#By_Eric_Raymond)!
  • Translators. Even though the PrestaShop tool is mostly written by French developers, we have decided to write our documentation primarily in English so as to stay open to as many foreign cultures as possible. Hence, we are always glad to welcome new translators for languages that are lacking documentation – especially the ones in which the main site is translated: English, French, Spanish, Italian, German, and Portuguese.
  • Writers. If you feel the current documentation lacks pages on a specific topic... Well, here's your chance!

Do you feel up for it? Contact us!

The documentation website is actually a wiki. Therefore, anyone with an account can edit it at will. The catch is that you have to have an account, obviously. Not everyone can have one with edit rights: we like to know who edits!

There is currently not automatic way to create an account on the documentation site, it has to be done manually. Therefore, you must contact the documentation team first:

  • Send us an e-mail
  • Indicate which guides you intend to work on.
  • Indicate your chosen language
  • Tell us about yourself! We'd love to learn more about your relationship with PrestaShop.

Once you receive our confirmation e-mail, you can get to editing!

Priorities

Our priority is to fully document the current stable version of PrestaShop. That means v1.6.
Version 1.5 of PrestaShop is still very much used, but won't receive any update, so its documentation is done – apart for potential mistakes.

The highest priority currently lies with the Developer Guide and the Designer guide

The current user guide and complete, but can use some fresh ideas here and there, as well as constant proofreading.

Along with these big priorities are smaller priorities. These projects should be carefully dealt with, as they are popular documentation pages, and users rely on it more often than not.

  • The Getting Started guide, where people will come first when discovering PrestaShop.
  • The Updating PrestaShop guide, which will help users who cannot yet use the One-Click Update tool (only available since v1.4.4).
  • And of course, the User Guide, which explains each of the PrestaShop menus and features in detail. That's the biggest work, but one of the most useful there is, so it is in much need to stay up-to-date.

Last but not least, translation. PrestaShop is used in many languages, but the current documentation team only knows English and French. We need to have the three main user guides (Getting Started, Updating PrestaShop and User Guide) available in as many languages as possible, starting with Spanish, German, Italian, etc.

The documentation for v1.4 and v1.5 will be maintained for perpetuity, but will only receive updates for mistakes and typos.

Guidelines

Wiki tool

This website is powered by Confluence, which is an excellent wiki software from Atlassian – which, incidentally, also edits Jira, the software behind PrestaShop's Forge.

It is therefore highly advisable to get better acquainted with its documentation before editing a page or submitting anything for review, especially how pages and sub-pages are handled and how to use the editor. Do not hesitate to search the Confluence documentation for specific keywords.

File attachments

In order to be retrieved easily by the editor, the image files should be attached to the target page.

More general files, such as downloadables, should be uploaded to one of the subpages of the _InclusionLibrary, which is a hidden page where store files in a clear way. There are a handful of subpages available:

  • _PDFfiles: PDF files.
  • _PPT: PowerPoint files.
  • _Misc: Miscellaneous files.
  • No labels