diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index f8af7eea8..5e1dc95e0 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -2,31 +2,35 @@ name: Bug Report about: Create a report to help us improve. title: "[Bug] Your Bug Report Here" -labels: '' -assignees: '' - +labels: "" +assignees: "" --- -**Describe the bug** -A clear and concise description of what the bug is. +**Describe the bug** A clear and concise description of what the bug is. + +**To Reproduce** Steps to reproduce the behavior: -**To Reproduce** -Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error -**Expected behavior** -A clear and concise description of what you expected to happen. +**Expected behavior** A clear and concise description of what you expected to +happen. -**Screenshots** -If applicable, add screenshots to help explain your problem. +**Actual behavior** A clear and concise description of what actually happens. + +**Screenshots** If applicable, add screenshots to help explain your problem. **Operating System (please complete the following information):** - - OS: [e.g. Windows 10 19044.1889, Ubuntu 18.04, Mac OS Monterey 12.4] - - CLI Environment [e.g. Command Prompt, Powershell, Terminal] - - Version [e.g. 1.04] -**Additional context** -Add any other context about the problem here. +- OS: [e.g. Windows 10 19044.1889, Ubuntu 18.04, Mac OS Monterey 12.4] +- CLI Environment [e.g. Command Prompt, Powershell, Terminal] +- Version [e.g. 1.04] + +**Browser (please complete the following information):** + +- Browser: [e.g. Chrome, Firefox, Brave, Safari] +- Version [e.g. 1.04] + +**Additional context** Add any other context about the problem here. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6793b5258..8e32588e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,48 +1,108 @@ -# Contributing to Transcriptase -We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: +# Contributing to developer.sailpoint.com -- Reporting a bug -- Discussing the current state of the code -- Submitting a fix -- Proposing new features -- Becoming a maintainer +We love your input! We want to make contributing to this project as easy and +transparent as possible. Look below if you would like to: + +- [Reporting a bug](#report-bugs-using-our-repositorys-issueshttpsgithubcomsailpoint-ossdevelopersailpointcomissues) +- [Make a feature request](#make-a-feature-request-using-our-repositorys-issueshttpsgithubcomsailpoint-ossdevelopersailpointcomissues) +- [Submitting a fix](#submit-a-fix) +- [Submit a new feature](#submit-a-new-feature) +- [Submit a general issue or ask a question](#discuss-submit-general-issue-or-ask-a-question) + +# High-level Guidelines ## We Develop with Github -We use github to host code, to track issues and feature requests, as well as accept pull requests. + +We use github to host code, to track issues and feature requests, as well as +accept pull requests. ## We Use [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow), So All Code Changes Happen Through Pull Requests -Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow)). We actively welcome your pull requests: + +Pull requests are the best way to propose changes to the codebase (we use +[Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow)). +We actively welcome your pull requests: 1. Fork the repo and create your branch from `main`. -2. If you've added code that should be tested, add tests. -4. Ensure the test suite passes. -5. Make sure your code lints. -6. Issue your pull request! +2. Make your changes. +3. Issue your pull request! ## Any contributions you make will be under the MIT Software License -In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern. -## Report bugs using Github's [issues](https://github.com/sailpoint-oss/developer.sailpoint.com/issues) -We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new); it's that easy! +In short, when you submit code changes, your submissions are understood to be +under the same [MIT License](http://choosealicense.com/licenses/mit/) that +covers the project. -## Write bug reports with detail, background, and sample code +# Report Bugs Using Our Repository's [issues](https://github.com/sailpoint-oss/developer.sailpoint.com/issues) -**Great Bug Reports** tend to have: +People _love_ thorough bug reports. We use GitHub issues to track bugs publicly. +Report a bug by +[opening a new bug](https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here); +it's that easy! -- A quick summary and/or background +## Write Bug Reports With Detail, Background, and Sample Code + +**Great bug reports** tend to have: + +- A quick summary and/or description - Steps to reproduce - Be specific! - Give sample code if you can. - What you expected would happens - What actually happens -- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) +- Screenshots! +- Operating System +- Browser +- Notes (possibly including why you think this might be happening, or stuff you + tried that didn't work) -People *love* thorough bug reports. +# Make A Feature Request Using Our Repository's [issues](https://github.com/sailpoint-oss/developer.sailpoint.com/issues) -## Use a Consistent Coding Style +We use GitHub issues to track feature requests. Request a feature request by +[opening a new feature request](https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=feature-request.md&title=%5BFeature%5D+Your+Feature+Request+Here); +it's that easy! -* 2 spaces for indentation rather than tabs -* You can try running `npm run lint` for style unification +## Write Feature Requests With Detail -## License -By contributing, you agree that your contributions will be licensed under its MIT License. +**Great feature requests** tend to: + +- Say if this is related to a problem (and describe said problem) +- Describe the solution you'd like +- Describe alternatives you use or have considered +- Notes (possibly including why you think this might benefit others, too) + +# Submit a Fix + +Looking to take on fixing something yourself? Great! Here's the short on how to +do it: + +- Fork the repository, copy the main branch only +- Pull down the code, build, and ensure it's running properly +- Create a new branch from main with the naming convention `fix/your-fix-name` +- Create a pull request from your branch to our origin repository's main branch! + +# Submit a New Feature + +Looking to take on adding a new feature? Great! Here's the short on how to do +it: + +- Fork the repository, copy the main branch only +- Pull down the code, build, and ensure it's running properly +- Create a new branch from main with the naming convention + `feature/your-feature-name` +- Create a pull request from your branch to our origin repository's main branch! + +# Discuss, Submit General Issue, or Ask a Question + +If none of the above work, you can submit a general issue using GitHub's +[issues](https://github.com/sailpoint-oss/developer.sailpoint.com/issues). You +can also head over to the +[Developer Community forum](https://developer.sailpoint.com/discuss) to discuss +with us directly on the forum about what you're thinking! + +- 2 spaces for indentation rather than tabs +- You can try running `npm run lint` for style unification + +# License + +By contributing, you agree that your contributions will be licensed under its +MIT License. diff --git a/README.md b/README.md index b938cbbeb..71c6c1401 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,15 @@ ![Latest Releases][release-shield] ![Contributor Shield][contributor-shield] [![Deploy to Production](https://github.com/sailpoint-oss/developer.sailpoint.com/actions/workflows/build-and-deploy-prod-gh-pages.yml/badge.svg)](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/ -[issues-shield]: https://img.shields.io/github/issues/sailpoint-oss/developer.sailpoint.com?label=Issues -[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 +[issues-shield]: + https://img.shields.io/github/issues/sailpoint-oss/developer.sailpoint.com?label=Issues +[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
@@ -27,17 +31,26 @@ ## 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. +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. +Please use GitHub +[issues](https://github.com/sailpoint-oss/developer.sailpoint.com/issues) to +[submit bugs](https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here) +or make +[feature requests](https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=feature-request.md&title=%5BFeature%5D+Your+Feature+Request+Here). + +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. @@ -49,36 +62,29 @@ npm install npm@latest -g ### Installation 1. Clone the repo + ```bash git clone https://github.com/sailpoint-oss/developer.sailpoint.com.git ``` -2. Install NPM packages + +2. Install the project's NPM packages + ```bash npm install ``` -3. Generate the docs + +3. Generate the API docs. They are auto-generated, so we do not track them in + the repository and instead build them at runtime. + ```bash npm run gen-api-docs-all ``` + 4. Start the website ```bash npm run start ``` -### Running the Algolia crawler - -1. Setup a .env file inside the algolia folder - ```sh - 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](https://developer.sailpoint.com/discuss) to discuss this tool with @@ -95,9 +101,10 @@ information. ## Contributing -Before you contribute you must sign our CLA. Please also read our -[contribution guidelines](./CONTRIBUTING.md) for all the details on -contributing. +Before you contribute you +[must sign our CLA](https://cla-assistant.io/sailpoint-oss/developer.sailpoint.com). +Please also read our [contribution guidelines](./CONTRIBUTING.md) for all the +details on contributing.