SailPoint Developer Community - README

About The Project

This repository contains the complete build, with assets, for everything seen on developer.sailpoint.com. This includes the homepage, all static elements, documentation, API specifications, et. al. The API specifications come in from a GitHub Action in another repository, but ultimately the API specifications used to generate this static site are those found in the static folder.

Please use GitHub issues to submit bugs or make feature requests.

If you'd like to contribute directly (which we encourage!) please read the contribution guidelines below, first!

Getting Started

If you want to build this project locally, follow the steps below.

Prerequisites

To run this project you must first have npm installed.

npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/sailpoint-oss/developer.sailpoint.com.git

2. Create a .npmrc file and add the following contents. If you are not a SailPoint employee, you will need to provide your own fontawesome token.

   @awesome.me:registry=https://npm.fontawesome.com/
   @fortawesome:registry=https://npm.fontawesome.com/
   //npm.fontawesome.com/:_authToken=<your token here>
   

3. Install the project's NPM packages

   npm install --legacy-peer-deps

4. Generate the API docs. They are auto-generated, so we do not track them in the repository and instead build them at runtime.

   npm run gen-api-docs-all

5. Start the website

   npm run start

Discuss

Click Here to discuss this tool with other users.

License

Distributed under the MIT License. See the license for more information.

Contributing

Before you contribute you must sign our CLA. Please also read our contribution guidelines for all the details on contributing.

Code of Conduct

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. Read our code of conduct to learn more.

(back to top)