Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

56 lines (36 loc) · 1.9 KB
Raw

Contributing

We welcome PRs from the community. To add a new tutorial, we ask that you generally follow the format listed in the template below. Clear images are required; we will reject all PRs without (or with unclear) images.

Please submit the following completed template to this directory: https://github.com/trufflesecurity/how-to-rotate/tree/main/content/docs/tutorials

---
title: <saas_provider>
---

*This tutorial provides step-by-step instructions on how to rotate a <saas_provider> <saas_provider_key_type>.*

---

## Generate a new <saas_provider> <saas_provider_key_type>

### Step 1 - Navigate to the <saas_provider_key_type> page
Provide instructions on how to navigate to the SaaS Provider's API Key page.

> To add images, create a new folder titled <saas_provider> (all lowercase) in the `themes/compose/static/images` folder. Add your images there. Then reference them in markdown like this: `![](/images/github/2.png)`

### Step 2 - Generate a new <saas_provider_key_type>
#### 2a. Sub-step heading
(Optional) Sub-step directions. Include an image for most (if not all) sub-steps.
...

---

## Replace the Leaked <saas_provider> <saas_provider_key_type>
Replace the leaked <saas_provider> <saas_provider_key_type> with the new one in all impacted applications and services.

---

## Revoke the Leaked <saas_provider> <saas_provider_key_type>

### Step 1 - Navigate to the <saas_provider_key_type> page
Provide instructions on how to navigate to the SaaS Provider's API Key page. (Usually same as Step 1 above).

### Step 2 - Revoke the <saas_provider_key_type>
#### 2a. Sub-step heading
(Optional) Sub-step directions. Include an image for most (if not all) sub-steps.
...

---

## Best Practices

##### Best Practice Sub-Title
Details with a link.

---

## Resources
- [<saas_provider> <saas_provider_key_type> Documentation](#)