mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 12:27:47 +00:00
updated readme
This commit is contained in:
68
README.md
68
README.md
@@ -1,23 +1,25 @@
|
|||||||
<a id="readme-top"></a>
|
<a id="readme-top"></a>
|
||||||
|
|
||||||
[![Discourse Topics][discourse-shield]][discourse-url]
|
[![Discourse Topics][discourse-shield]][discourse-url] ![Issues][issues-shield]
|
||||||
![Issues][issues-shield]
|
![Latest Releases][release-shield] ![Contributor Shield][contributor-shield]
|
||||||
![Latest Releases][release-shield]
|
|
||||||
![Contributor Shield][contributor-shield]
|
|
||||||
[](https://github.com/sailpoint-oss/developer.sailpoint.com/actions/workflows/build-and-deploy-prod-gh-pages.yml)
|
[](https://github.com/sailpoint-oss/developer.sailpoint.com/actions/workflows/build-and-deploy-prod-gh-pages.yml)
|
||||||
|
|
||||||
[discourse-shield]: https://img.shields.io/discourse/topics?label=Discuss%20This%20Tool&server=https%3A%2F%2Fdeveloper.sailpoint.com%2Fdiscuss
|
[discourse-shield]:
|
||||||
|
https://img.shields.io/discourse/topics?label=Discuss%20This%20Tool&server=https%3A%2F%2Fdeveloper.sailpoint.com%2Fdiscuss
|
||||||
[discourse-url]: https://developer.sailpoint.com/discuss/
|
[discourse-url]: https://developer.sailpoint.com/discuss/
|
||||||
[issues-shield]:https://img.shields.io/github/issues/sailpoint-oss/developer.sailpoint.com?label=Issues
|
[issues-shield]:
|
||||||
[release-shield]: https://img.shields.io/github/v/release/sailpoint-oss/developer.sailpoint.com?label=Current%20Release
|
https://img.shields.io/github/issues/sailpoint-oss/developer.sailpoint.com?label=Issues
|
||||||
[contributor-shield]:https://img.shields.io/github/contributors/sailpoint-oss/developer.sailpoint.com?label=Contributors
|
[release-shield]:
|
||||||
|
https://img.shields.io/github/v/release/sailpoint-oss/developer.sailpoint.com?label=Current%20Release
|
||||||
|
[contributor-shield]:
|
||||||
|
https://img.shields.io/github/contributors/sailpoint-oss/developer.sailpoint.com?label=Contributors
|
||||||
|
|
||||||
<!-- PROJECT LOGO -->
|
<!-- PROJECT LOGO -->
|
||||||
<br />
|
<br />
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<img src="./static/img/SailPoint-Developer-Community-Lockup.png" alt="Logo">
|
<img src="./static/img/SailPoint-Developer-Community-Lockup.png" alt="Logo">
|
||||||
|
|
||||||
<h3 align="center">Developer Community Website - README</h3>
|
<h3 align="center">SailPoint Developer Community - README</h3>
|
||||||
<br/>
|
<br/>
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<img src="./static/img/screenshot.png" width="500" height="" style="text-align:center">
|
<img src="./static/img/screenshot.png" width="500" height="" style="text-align:center">
|
||||||
@@ -25,15 +27,25 @@
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<!-- ABOUT THE PROJECT -->
|
<!-- ABOUT THE PROJECT -->
|
||||||
|
|
||||||
## About The Project
|
## 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, docs, and the API specifications. 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.
|
|
||||||
|
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.
|
Please use GitHub issues to submit bugs or make feature requests.
|
||||||
|
|
||||||
<!-- GETTING STARTED -->
|
<!-- GETTING STARTED -->
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
To run this project you must first have npm installed.
|
To run this project you must first have npm installed.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
npm install npm@latest -g
|
npm install npm@latest -g
|
||||||
```
|
```
|
||||||
@@ -41,19 +53,19 @@ npm install npm@latest -g
|
|||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
1. Clone the repo
|
1. Clone the repo
|
||||||
```sh
|
```bash
|
||||||
git clone https://github.com/sailpoint-oss/developer.sailpoint.com.git
|
git clone https://github.com/sailpoint-oss/developer.sailpoint.com.git
|
||||||
```
|
```
|
||||||
2. Install NPM packages
|
2. Install NPM packages
|
||||||
```sh
|
```bash
|
||||||
npm install
|
npm install
|
||||||
```
|
```
|
||||||
3. Generate the docs
|
3. Generate the docs
|
||||||
```sh
|
```bash
|
||||||
npm run docusaurus gen-api-docs all
|
npm run docusaurus gen-api-docs all
|
||||||
```
|
```
|
||||||
4. Start the website
|
4. Start the website
|
||||||
```sh
|
```bash
|
||||||
npm start
|
npm start
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -69,14 +81,34 @@ npm install npm@latest -g
|
|||||||
docker run -it --env-file=./algolia/.env -e "CONFIG=$(cat ./algolia/config.json | jq -r tostring)" algolia/docsearch-scraper
|
docker run -it --env-file=./algolia/.env -e "CONFIG=$(cat ./algolia/config.json | jq -r tostring)" algolia/docsearch-scraper
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<!-- CONTACT -->
|
||||||
|
|
||||||
|
## Discuss
|
||||||
|
|
||||||
|
[Click Here](https://developer.sailpoint.com/dicuss) to discuss this tool with
|
||||||
|
other users.
|
||||||
|
|
||||||
<!-- LICENSE -->
|
<!-- LICENSE -->
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Distributed under the MIT License. See `LICENSE.txt` for more information.
|
Distributed under the MIT License. See [the license](./LICENSE) for more
|
||||||
|
information.
|
||||||
|
|
||||||
|
<!-- CONTRIBUTING -->
|
||||||
|
|
||||||
<!-- CONTACT -->
|
## Contributing
|
||||||
## Discuss
|
|
||||||
[Click Here](https://developer.sailpoint.com/dicuss) to discuss this tool with other users.
|
Before you contribute you must sign our CLA. Please also read our
|
||||||
|
[contribution guidelines](./CONTRIBUTING.md) for all the details on
|
||||||
|
contributing.
|
||||||
|
|
||||||
|
<!-- CODE OF CONDUCT -->
|
||||||
|
|
||||||
|
## 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](./CODE_OF_CONDUCT.md) to learn more.
|
||||||
|
|
||||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||||
|
|||||||
Reference in New Issue
Block a user