docs: update PlatformX doc with steps from README #16406
Conversation
There was a problem hiding this comment.
Currently, I'm still in favor of keeping the source of truth in the README since many people will want to read/fork/modify the code before deploying and deploying is arbitrary (e.g. I didn't package it via helm, etc).
If we do want to keep the docs here (I previewed it and it looks good), let's definitely link to the repo still and reconsider what we want to put in the README (maybe we link the README to the docs, then)?
docs/admin/integrations/platformx.md
Outdated
| - A running Coder v2.19+ deployment | ||
| - A PlatformX subscription from [DX](https://getdx.com/) | ||
| - A platform to host the integration (choose any of these): | ||
| - AWS Lambda | ||
| - Heroku | ||
| - Kubernetes | ||
| - Or any other platform that can run Python web applications |
There was a problem hiding this comment.
Where should we put the requirements? Why was this removed?
There was a problem hiding this comment.
that was my mistake - I think I cut it while moving it and then didn't put it back
un-removed it
| - AWS Lambda | ||
| - Google Cloud Run |
There was a problem hiding this comment.
added this based on the readme
This middleware is optimized for serverless environments such as Google Cloud Run and AWS Lambda.
|
Let's ship it :) can always adjust based on feedback |
|
/cherry-pick release/2.19 |
copied and reformatted the steps from the https://github.com/coder/coder-platformx-notifications README to include them as an example in the Coder docs
preview