pieces-app / documentation

Official documentation for Pieces for Developers
https://docs.pieces.app
266 stars 34 forks source link

Quick "How to Video - Enabling Workstream Pattern Engine Permissions on MacOS" #428

Closed tsavo-at-pieces closed 1 month ago

tsavo-at-pieces commented 1 month ago

Need a quick video on enabling WPE for MacOS from within the app.

@mack-at-pieces maybe you can knock this one out with a quick screen record. Doesn't need any voice over or anything. Just want it for the documentation.

@laurin-at-pieces if you end up knocking this out - you'll likely need to start on a fresh DB and ensure the permissions from before were disabled.

@landon-at-pieces can get this up on YT once it is done and comment the link here on this issue.

@mason-at-pieces can get this into the documentation at relevant locations from there!

mack-at-pieces commented 1 month ago

I can lead the charge on this one.

mason-at-pieces commented 1 month ago

Perfect @mack-at-pieces, if you just upload those videos as mp4s here, ill make sure they get everywhere they are needed on the docs

mack-at-pieces commented 1 month ago

@mason-at-pieces @laurin-at-pieces @landon-at-pieces @tsavo-at-pieces these may require a little editing - lmk if you'd like me to just edit it or share other form factors.

This is enabling the WPE from Settings: MP4 - https://github.com/pieces-app/documentation/assets/30325757/619edb4e-a197-41fd-adfc-83576bd2fde5 Raw Screen Studio - https://drive.google.com/drive/folders/1bOO01oUZYSSAao3EpwjhgMPKaa_rbQ-W?usp=drive_link

Instructions:

This is enabling the WPE after first message: MP4 - https://github.com/pieces-app/documentation/assets/30325757/acdc5ced-9395-42b3-9f03-578219591bf6 Raw Screen Studio - https://drive.google.com/drive/folders/1musBLyradRRsbfC7OSaUPzdcYQUa-zdR?usp=drive_link

For Raw SS Folders: Just download the raw folder from Drive and de-compress it and it'll be the screenstudio file

Instructions:

Can re-record any if needed! Lmk!

tsavo-at-pieces commented 1 month ago

Looks great for starters - @landon-at-pieces if you could do some holds / zooms i.e. kinda following the cursor around and making sure everything has time to be consumed that would be great!

Other thing we might need to do is show a keyboard shortcut as a visible subtitle/title slide right before mack launches the power menu.

I.e. "Get started by navigating to settings via the Command Pallet (CMD+SHIFT+P on macOS)"

In the command pallet type "Go To Settings" etc..

landon-at-pieces commented 1 month ago

Here we go.

What do we think about this one: https://drive.google.com/file/d/1YsPTdtDxGR4yIwzl20biFrCM5-q_HE_T/view?usp=drive_link

mack-at-pieces commented 1 month ago

This is litttt @landon-at-pieces . @tsavo-at-pieces how's the pace for you? I kinda like the upbeat nature of it. Ppl can pause it as they see fit.

tsavo-at-pieces commented 1 month ago

Excellent!

On Tue, May 21, 2024, 2:44 PM Mack Myers @.***> wrote:

This is litttt @landon-at-pieces https://github.com/landon-at-pieces . @tsavo-at-pieces https://github.com/tsavo-at-pieces how's the pace for you? I kinda like the upbeat nature of it. Ppl can pause it as they see fit.

— Reply to this email directly, view it on GitHub https://github.com/pieces-app/documentation/issues/428#issuecomment-2123234093, or unsubscribe https://github.com/notifications/unsubscribe-auth/AYN4Z5KNZGHCCN72CPZE75TZDOIZPAVCNFSM6AAAAABIAAWBUCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMRTGIZTIMBZGM . You are receiving this because you were mentioned.Message ID: @.***>

tsavo-at-pieces commented 1 month ago

Let's get it on YouTube!

On Tue, May 21, 2024, 4:42 PM Tsavo Knott @.***> wrote:

Excellent!

On Tue, May 21, 2024, 2:44 PM Mack Myers @.***> wrote:

This is litttt @landon-at-pieces https://github.com/landon-at-pieces . @tsavo-at-pieces https://github.com/tsavo-at-pieces how's the pace for you? I kinda like the upbeat nature of it. Ppl can pause it as they see fit.

— Reply to this email directly, view it on GitHub https://github.com/pieces-app/documentation/issues/428#issuecomment-2123234093, or unsubscribe https://github.com/notifications/unsubscribe-auth/AYN4Z5KNZGHCCN72CPZE75TZDOIZPAVCNFSM6AAAAABIAAWBUCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMRTGIZTIMBZGM . You are receiving this because you were mentioned.Message ID: @.***>

mason-at-pieces commented 1 month ago

@tsavo-at-pieces The only thing on the docs end is that the file is large so we'd have to embed the yt video for this one however the other videos are not yt embeds.

@landon-at-pieces Is there any way we can get a shorter version of this for the docs?

landon-at-pieces commented 1 month ago

Good deal. Will get this up.

On Tue, May 21, 2024 at 3:51 PM Mason Williams @.***> wrote:

@tsavo-at-pieces https://github.com/tsavo-at-pieces The only thing on the docs end is that the file is large so we'd have to embed the yt video for this one however the other videos are not yt embeds.

@landon-at-pieces https://github.com/landon-at-pieces Is there any way we can get a shorter version of this for the docs?

— Reply to this email directly, view it on GitHub https://github.com/pieces-app/documentation/issues/428#issuecomment-2123421362, or unsubscribe https://github.com/notifications/unsubscribe-auth/BIOSG5TC2TEZYHN3OCAAEJDZDOXVHAVCNFSM6AAAAABIAAWBUCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMRTGQZDCMZWGI . You are receiving this because you were mentioned.Message ID: @.***>

landon-at-pieces commented 1 month ago

@mason-at-pieces -- What's the max file size you can embed?

mason-at-pieces commented 1 month ago

An example of one up is at 25mb but ideally they are under 10mb. Mainly just didn't want to upload a 300mb file into the docs repo haha, so any compression is good

landon-at-pieces commented 1 month ago

Do you still want the music version? or just a compressed no audio version?

tsavo-at-pieces commented 1 month ago

Can we embed the youtube video?

Tsavo Knott Co-Founder & CEO https://www.linkedin.com/in/tsavoknott/ @pieces.app https://code.pieces.app/

On Tue, May 21, 2024 at 6:16 PM, Mason Williams @.***> wrote:

An example of one up is at 25mb but ideally they are under 10mb. Mainly just didn't want to upload a 300mb file into the docs repo haha, so any compression is good

— Reply to this email directly, view it on GitHub https://github.com/pieces-app/documentation/issues/428#issuecomment-2123525671, or unsubscribe https://github.com/notifications/unsubscribe-auth/AYN4Z5I4AEPVTTCMNG5IJKLZDPBSJAVCNFSM6AAAAABIAAWBUCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMRTGUZDKNRXGE . You are receiving this because you were mentioned.Message ID: @.***>

mason-at-pieces commented 1 month ago

Can we embed the youtube video?

We can but it'll be the only embedded yt video on the page while all the others are mp4/webm. Just isn't as clean as if we had the videos in the repo

tsavo-at-pieces commented 1 month ago

Okay that's probably fine - for performance reasons is it better to embed a youtube video or are the mp4's streamed?

Other thing about embedding YT videos where we can is they get views and we have analytics on em.

Tsavo Knott Co-Founder & CEO https://www.linkedin.com/in/tsavoknott/ @pieces.app https://code.pieces.app/

On Tue, May 21, 2024 at 6:41 PM, Mason Williams @.***> wrote:

Can we embed the youtube video?

We can but it'll be the only embedded yt video on the page while all the others are mp4/webm

— Reply to this email directly, view it on GitHub https://github.com/pieces-app/documentation/issues/428#issuecomment-2123549558, or unsubscribe https://github.com/notifications/unsubscribe-auth/AYN4Z5LC7YCFJHQQB37F7ATZDPERLAVCNFSM6AAAAABIAAWBUCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMRTGU2DSNJVHA . You are receiving this because you were mentioned.Message ID: @.***>

mason-at-pieces commented 1 month ago

for performance reasons is it better to embed a youtube video or are the mp4's streamed?

As far as performance goes, Id assume the embed is better because it prob just renders a thumbnail and then streams in the video once a user clicks on it to play rather than the whole video being rendered at runtime.

Other thing about embedding YT videos where we can is they get views and we have analytics on em.

I actually think yt counts embed views differently or are just way more strict but with the embed it could lead to users going to our youtube which is a plus.

My only thing is that this video seems to be in between our youtube style videos and our gif style videos so it just isn't clear on where it should go.

landon-at-pieces commented 1 month ago

Here's live YT link: https://www.youtube.com/watch?v=-zdK1bX0W-Y

Also here's a compressed (audioless) file if you want to embed: https://drive.google.com/file/d/1YTRCQ6RZoN0JPZeqOuJEQm4VAMsHPmvh/view?usp=drive_link

tsavo-at-pieces commented 1 month ago

Im game for either or! Maybe if we have youtube videos we use them and if not we use the raw videos from here on out?

Tsavo Knott Co-Founder & CEO https://www.linkedin.com/in/tsavoknott/ @pieces.app https://code.pieces.app/

On Tue, May 21, 2024 at 6:53 PM, Mason Williams @.***> wrote:

for performance reasons is it better to embed a youtube video or are the mp4's streamed?

As far as performance goes, Id assume the embed is better because it prob just renders a thumbnail and then streams in the video once a user clicks on it to play rather than the whole video being rendered at runtime.

Other thing about embedding YT videos where we can is they get views and we have analytics on em.

I actually think yt counts embed views differently or are just way more strict but with the embed it could lead to users going to our youtube which is a plus.

My only thing is that this video seems to be in between our youtube style videos and our gif style videos so it just isn't clear on where it should go.

— Reply to this email directly, view it on GitHub https://github.com/pieces-app/documentation/issues/428#issuecomment-2123560189, or unsubscribe https://github.com/notifications/unsubscribe-auth/AYN4Z5KIWU44FJ37662DSSTZDPF6RAVCNFSM6AAAAABIAAWBUCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMRTGU3DAMJYHE . You are receiving this because you were mentioned.Message ID: @.***>