Skip to content
This repository has been archived by the owner on Nov 15, 2022. It is now read-only.

Protocols #81

Merged
merged 10 commits into from
May 28, 2021
Merged

Protocols #81

merged 10 commits into from
May 28, 2021

Conversation

jeremyw24
Copy link
Contributor

Add protocols section covering various protocols used by PlaceOS as supporting content;

  • http
  • oauth2
  • saml
  • mqtt

@vercel
Copy link

vercel bot commented May 24, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/placeos/docs/3PSKZ4Rc2JenEL31iMQQGxY7Dpi7
✅ Preview: https://docs-git-protocols-placeos.vercel.app

[Deployment for 6e7d8e3 failed]

@jeremyw24 jeremyw24 self-assigned this May 24, 2021
@jeremyw24
Copy link
Contributor Author

Temporarily removed http protocol to be revisited at a future date, not currently required.

@mghill
Copy link
Contributor

mghill commented May 26, 2021

Didn't get to this one today will do tomorrow. Before I start, have they been checked against the other doc pages (i.e. guides) on these topics? Happy to do that as part of the review/editing.

@jeremyw24
Copy link
Contributor Author

Didn't get to this one today will do tomorrow. Before I start, have they been checked against the other doc pages (i.e. guides) on these topics? Happy to do that as part of the review/editing.

These are not intended to be related to the other docs, they are simply an overview/refresher of the protocol itself, how we use it and references specifically to that protocol itself. They are not designed to be read in conjunction with any of the other docs.

@mghill
Copy link
Contributor

mghill commented May 27, 2021

Had a look over it, only remaining concern I think is that there's a broken internal link on the MQTT page. I didn't remove it yet as I'm not sure if it refers to a document in another branch which is coming up

@jeremyw24
Copy link
Contributor Author

@mghill yes I figured we could push this and mqtt at the same time.

@mghill
Copy link
Contributor

mghill commented May 27, 2021

Ah, yeah we can do that. I was a bit confused because that isn't the file path used in #29
I'll do a quick commit to make them match and then I think it's all good

Provide updates implemented via #84 to enable preview ahead of merge.
@jeremyw24 jeremyw24 merged commit 18c233d into main May 28, 2021
@jeremyw24 jeremyw24 deleted the protocols branch May 28, 2021 00:03
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants