Skip to content

Commit 165f44f

Browse files
hari-kuriakosepre-commit-ci[bot]ritwik-g
authored
Add CONTRIBUTING.md (#725)
* * Add contributing * Update run platform script user guide in README * Update encryption key backup reminder in README * Fix contributing md doc link in readme * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Ritwik G <100672805+ritwik-g@users.noreply.github.com>
1 parent f30b6bc commit 165f44f

3 files changed

Lines changed: 11 additions & 256 deletions

File tree

CONTRIBUTE.md

Lines changed: 0 additions & 255 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Contributing
2+
3+
See [docs.unstract.com](https://docs.unstract.com/contributing/unstract).

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ Next, either download a release or clone this repo and do the following:
5858

5959
That's all there is to it!
6060

61+
See [user guide](https://docs.unstract.com/unstract_platform/user_guides/run_platform) for more details on managing the platform.
6162
Another really quick way to experience Unstract is by signing up for our [hosted version](https://us-central.unstract.com/).
6263

6364
## ⏩ Quick Start Guide
@@ -137,14 +138,20 @@ Unstract comes well documented. You can get introduced to the [basics of Unstrac
137138

138139
## 🙌 Contributing
139140

140-
Contributions are welcome! Please read [CONTRIBUTE.md](CONTRIBUTE.md) for further details on setting up the development environment, etc. It also points you to other detailed documents as needed.
141+
Contributions are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for further details on setting up the development environment, etc. It also points you to other detailed documents as needed.
141142

142143
## 👋 Join the LLM-powered automation community
143144

144145
- On Slack, [join great conversations](https://join-slack.unstract.com) around LLMs, their ecosystem and leveraging them to automate the previously unautomatable!
145146
- [Follow us on X/Twitter](https://twitter.com/GetUnstract)
146147
- [Follow us on LinkedIn](https://www.linkedin.com/showcase/unstract/)
147148

149+
## 🚨 Backup encryption key
150+
151+
Do copy the value of `ENCRYPTION_KEY` config in either `backend/.env` or `platform-service/.env` file to a secure location.
152+
153+
Adapter credentials are encrypted by the platform using this key. Its loss or change will make all existing adapters inaccessible!
154+
148155
## 📊 A note on analytics
149156

150157
In full disclosure, Unstract integrates Posthog to track usage analytics. As you can inspect the relevant code here, we collect the minimum possible metrics. Posthog can be disabled if desired by setting `REACT_APP_ENABLE_POSTHOG` to `false` in the frontend's .env file.

0 commit comments

Comments
 (0)