This repository holds the sources for the documentation of the web API that was released in 1.7.
The API documentation can be found here: api.akeneo.com.
Install Docker Engine.
make buildThis is only building the documentation. The documentation is not available with this command, as it does not launch the HTTP server.
make watchThe API documentation site is then available on localhost:8000.
Files located in the content and src directories are watched for changes, so when developing you do not need to launch any other task.
Once you merge a PR into the master branch, it is automatically deployed on the staging server. In order to deploy it in production, please follow these steps:
- Check the staging environment if everything is ok to be deployed in production
- Open the list of merged PR in master branch in Circle CI. You have to be connected with your Github account.
- Click on the first row which should be "On hold"
- Click on the box "approve_to_deploy_in_production" and approve. It will launch the deployment in production.
- It's deployed in production in 1 minute!
Your public SSH key should be deployed on the server (see Ansible configuration). It is strongly recommended to release with the CI process though.
HOSTNAME=xxx PORT=xxx make deployHOSTNAME is the server to deploy the documentation on. PORT is the SSH port to connect to the server.
To know the production and staging environments of api-docs, please read the inventory.
As our YAML Swagger spec uses references and links, it is considered as non-valid.
During the build, we generate a valid JSON specification that is put under the content/swagger folder. Don't forget to version it if you made any change into the YAML Swagger spec.