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!
  • 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.
  • 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 page(s) 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.4 for now, but comes v1.5, all the content from the 1.4 will be copied to a new folder, and will have to be updated. That will mean more proofreading, and more screen-captures to make. Yay!

Within that big priority are smaller priorities, namely:

  • 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 tabs and functioning in detail. That's the biggest work, but one of the most useful there is, so it in much need to stay up-to-date.

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 it's User Guide before editing a page or submitting anything for review, especially its wiki syntax (even though you can use a WYSIWYG editor by default) and how pages and sub-pages are handled. Do not hesitate to search the Confluence documentation for specific keywords.

File attachments (inline images)

In order to be used easily on any page of the wiki, files should not be attached to the page they're used in, but 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:

  • _Excerpts: information which is included in other pages. Mostly, content that remains true for any version of PrestaShop, and thus needs only be updated in one place rather than for all of the PrestaShop versions.
  • _Images: Screen captures and images, in English only.
  • _ImagesES: Screen captures and images, in Spanish only.
  • _ImagesFR: Screen captures and images, in French only.
  • _Misc: Miscellaneous files.
  • _PDFfiles: PDF files.
  • _PPT: PowerPoint files.
  • No labels