matthieu-rolland / devdocs-site

Site for the technical documentation

PrestaShop Technical Documentation Site

This repository contains the sources to build DevDocs - PrestaShop's technical documentation site.

Contributing

• To contribute content, read this guide. Documentation content is tracked in the Docs Repository.
• To update the theme: Submit your Pull Request to the Theme repository.

Rendering the site locally

Using docker-compose

1. Clone the repository somewhere on your system:

   git clone --recurse-submodules https://github.com/PrestaShop/devdocs-site.git
   

2. Switch to the devdocs-site directory:

   cd devdocs-site
   

3. Create .env file by .env.example:

   cp .env.example .env
   

4. Launch Hugo service:

   docker-compose up hugo
   

Natively

Setting up your environment

1. Install Hugo. You will need v0.82+ (extended binary)

   • Mac and Linux: Run ./bin/installHugo.sh
   • Windows: Grab the release binary

   Or read the Official install guide.

2. Clone the repository somewhere on your system

   git clone --recurse-submodules https://github.com/PrestaShop/devdocs-site.git
   

Launching the site

1. Switch to the src directory:

   cd /path/to/devdocs-site/src
   

2. Launch Hugo:

   hugo server
   

   You may need to change the path to the hugo binary depending on where it is on your system

3. Done! You can open up the site on your browser.

   It's usually available at http://localhost:1313

   Any change you perform on your data will be updated almost instantly.

Customizing the style

We use Sass for styling, bundled by Hugo itself.

The source files for the main css & js are in the assets directory of the theme's repository.

Deployment

• The sources of this site are hosted on devdocs-site, the Sources repository.
• The Hugo theme of this site is hosted on ps-docs-theme, the Theme repository.
• The content of this site is hosted on docs, the Content Repository.

Every time a contribution is merged inside one of the docs branches, a first GitHub workflow will notify the Sources repository.

Upon being notified, a second GitHub workflow is triggered in devdocs-site, which updates its submodules and commits them.

This commit triggers a third GitHub workflow that will deploy the latest version to devdocs.prestashop-project.org .

Theme updates do not trigger a deployment, consequently following a theme update, the docs website must be deployed manually.

License

Content from this documentation is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.