Helpcenter for the Partners and Customers Portal
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
content
src
styles
tasks
.gitignore
README.md
article-template.md
config.json.dist
gulpfile.js
package.json

README.md

Akeneo Portal Help center

This repository holds the sources for the Customer and Partner Portal help center, made by hand with love.

Install/preview the help center

First, you will need Node as well as Gulp-cli.

Then you can run the following commands in your terminal where these sources are:

sudo npm install --global n
sudo n 7.2.0
npm install
sudo npm install --global gulp-cli

Run locally

Once Node and gulp-cli installed, run in your root folder after cloning/downloading the Helpcenter sources:

npm install

gulp serve

The help center website is then available on localhost:8000. Files located in the content and src directories are watched for changes, so when developing or writing new articles you do not need to launch any other task.

Deploy the helpcenter

Update your installation

git checkout master; git pull

npm install 

Create a ./config.json file in the root of the repository:

{
  "staging": {
    "hostname": "help-staging",
    "username": "akeneo",
    "destination": "/home/akeneo/portal"
  },
  "production": {
    "hostname": "help",
    "username": "akeneo",
    "destination": "/home/akeneo/portal"
  }
}  

Generate the help center then deploy it:

gulp deploy --env=staging

If you want to deploy on production, use

gulp deploy --env=production

For more info, see How to deploy the documentation.