SailPoint Developer Community - README

About The Project

This repository contains the complete build, with assets, for everything seen on developer.sailpoint.com. The 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.

Getting Started

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. Install NPM packages

   npm install
   

3. Generate the docs

   npm run docusaurus gen-api-docs all
   

4. Start the website

   npm run start
   

Running the Algolia crawler

1. Setup a .env file inside the algolia folder

   APPLICATION_ID={APP_ID}
   API_KEY={API_KEY}
   

2. Run the Algolia crawler using docker

   docker run -it --env-file=./algolia/.env -e "CONFIG=$(cat ./algolia/config.json | jq -r tostring)" algolia/docsearch-scraper
   

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)