This repository contains the source code and documentation powering api-platform.com.
Single Page Application built with React and powered by Gatsby.
For an overview of the project structure, please refer to the Gatsby documentation.
To run the installation script, you will need jq. Be sure to install them first and to have the binaries in your path.
# Checkout project git clone https://github.com/api-platform/website.git # Change directory cd website # Install dependencies yarn install # Retrieve documentation bin/retrieve-documentation # Run project locally (for development) yarn gatsby develop > Go to http://localhost:8000/ # Build the project (for production) yarn gatsby build # Test the built project locally yarn gatsby serve > Go to http://localhost:9000
- Create a branch for the new version in the
api-platform/docsrepository. - Update Algolia DocSearch configuration
{
"index_name": "api-platform",
"start_urls": [
{
"url": "https://api-platform.com/docs/(?P<version>.*?)/",
"variables": {
"version": [
"main",
"2.6",
"2.5",
"2.4",
"2.3",
"2.2",
"2.1"
]
}
},
// ...
},
// ...
}- Add the new version in
constants.js
module.exports = Object.freeze({ // ... versions: ['main', '2.5', '2.4', '2.3', '2.2', '2.1'], currentVersion: '2.6', mainVersion: '2.7', // ... });
You need to use a valid github token to retrieve the list of contributors.
-
Go to your github developer settings
-
Select scopes
public_repo,read:organdread:user, generate the token and copy it. -
Create a new
.env.localfile on the root of your local website project, and set your token as an environment variable namedGITHUB_KEY.
❗Core team badges restriction: You need to be a member of API Platform organization to retrieve API Platform teams. You can still locally launch the project, but the badges of the core team members will not appear.