PG4D is PSA Groupe 4 Developpers website. It's a documentation webiste with references, tutorials and good practices for developers using Groupe PSA's APIs.
PG4D is a Jekyll static website using Bulma CSS framework. It is hosted on GitHub Pages. Search engine is Lunr.js.
You can "Propose File Change" with GitHub interface.
- If you don't have one, create an account on GitHub.
- Fork this repo.
- Pull the forked repo hosted on your account.
- Install Ruby & Jekyll.
- Use
bundle exec jekyll servecommand to browse the website locally. - Use git to commit and push your work on the external repo.
- Go to github.com, browse your fork of groupepsa.github.io and click
New pull request. - Give a name to the pull request and click
Create new pull request.
If the repo as been updated by someone else, this link could help: https://help.github.com/en/articles/syncing-a-fork
- includes: Files that can be included in a page of the website.
- layout: Files that construct the base layout of a page.
- sections: Webapi (b2b/b2c) / webportal. At the moment, mobile-sdk is not realeased.
- collections: Those folders begining with
underscoreare used as lists of files used to create content (like list of functions for sdk) - sass: The
overide.sassfile is used to update CSS of the framework. - config: in this config file is also stored the URL of the APIs as variables.
- content: in sections folders there is content folder that store some content of a section. It's a way to maintain only one document and display it in different sections.
- lunr.js: is a js library providing search engine for static website.
- swagger UI: is a javaScript program used to display OpenAPI spec files. Currently, used in Monitor B2B/B2C and Remote B2B.
- Redoc: as swagger UI, Redoc is a program used to display OpenAPI spec in Reference API B2B/B2C.