This repo contains the code and documentation that powers developers.sparkpost.com.
To develop with this repository, you must have the following:
cd developers.sparkpost.comto go into the website directory- Run
npm run bootstrapto install the npm dependencies
When developing locally, you have two options: developing the whole website or develop just the API reference section. All content will hot-reload. If you aren't seeing changes, restart the development server.
This will develop the whole developer site.
- Run
npm run develop - open http://localhost:4000/ to view the website.
This is what you want if you are making documentation changes.
This will only develop the API reference pages and skip unnecessary queries.
- You will need a SparkPost API key to generate the docs
- Run
SPARKPOST_API_KEY=<key> npm run docs - open http://localhost:4000/api/ to view the docs.
To develop Netlify Functions locally, run npm run lambda. This will start a second development server for the serverless functions.
Each file located in the lambda/ directory will be deployed as a serverless function.
You'll find the all the content, pages, and data inside the content folder. If you are contributing content, take a few minutes and read through the contributing guidelines.
Create a branch for your work in the repo:
git checkout masterto checkout the main branchgit pull origin masterto get the lastest codegit checkout -b your-branch-nameto create a branch
- Follow the Local development instructions to start the development server
- Make your changes as needed
- Changes to any files in the
contentandsrcdirectories will hot-reload. - If you make changes files in the
pluginsandgatsbydirectories or any top-level files, you will need to restart the server.
- Stage and commit your changes (
git add -A && git commit -m "Describe what you did") - Push your changes (
git push origin your-branch-name) - Create a Pull Request against the
masterbranch. Netlify will publish a deploy preview so you can share and preview your changes as a live site.
After you push your changes, you may see a commit you didn't make such as your-branch-name npm audit fix. We use auditmated to help keep our dependencies secure and up-to-date. To skip this, use the --no-verify command line option when you push your code.