Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation : glitch app link & video ingestion documentation #104

Merged
merged 10 commits into from
Jun 3, 2022

Conversation

ingrid011
Copy link

Description
We need to include sample code to make it easier for the user to know how to implement the tutorial by the .
Also, we need to add documentation related to video ingestion WebRTC vs RTMP related to the issue #11.

Implementation

  • Add sample glitch app link to the documentation in the webRTC tutorial

Screen Shot 2022-05-31 at 13 20 21

  • Add video ingestion article to the documentation

Screen Shot 2022-05-31 at 13 21 48

@ingrid011 ingrid011 added the documentation Improvements or additions to documentation label May 31, 2022
@ingrid011 ingrid011 requested review from tyohan and faiq-naufal May 31, 2022 06:25
@ingrid011 ingrid011 self-assigned this May 31, 2022
lastmod: 2022-05-31
name: Video Ingestion
title: Video Ingestion
description: Inlive support WebRTC as our video ingestion. We have RTMP in development on progress.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ingrid011 this is will be used as SEO description meta tag, so consider to replace it with a summary about the content.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tyohan Being revised to be : Inlive uses WebRTC which supports video ingestion on all platforms including web, has better latency than RTMP, and can be used to build your own OBS client.
If counted, it is 157 characters (still reach the SEO description best practice until 160 characters). Kindly advice is it okay mas?

Copy link
Member

@tyohan tyohan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ingrid011 I know in my article we don't have the link for some abbreviations like RTMP, WebRTC, and OBS. But will be great to refer them to a link that can explain it.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented May 31, 2022

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: d5fef58
Status: ✅  Deploy successful!
Preview URL: https://e148a50a.inlive-website.pages.dev

View logs

@tyohan
Copy link
Member

tyohan commented Jun 2, 2022

@ingrid011 it seems we have redundant menus for video input or ingestion as shows as in this screenshot
image. Video input and ingestion basically the same.

Maybe the video ingestion doc needs to change into Choosing RTMP vs WebRTC

@ingrid011
Copy link
Author

@ingrid011 it seems we have redundant menus for video input or ingestion as shows as in this screenshot image. Video input and ingestion basically the same.

Maybe the video ingestion doc needs to change into Choosing RTMP vs WebRTC

Apologize mas, at first I didn't know the terms are the same. 😅
If reading it, I agree for Choosing RTMP vs WebRTC. I'll revise it and give the thumb up emoji if done

@faiq-naufal
Copy link
Contributor

@tyohan @ingrid011 How about we group the video ingestion and video input into one category, for example "Learn" category (similar with the Tutorial). Because I think the content of video ingestion and video input fits with this category which provides an educational content to the user to ensure the user knows what we are offering to them and how our product can benefit to them.

@ingrid011
Copy link
Author

ingrid011 commented Jun 2, 2022

How about we group the video ingestion and video input into one category, for example "Learn" category (similar with the Tutorial). Because I think the content of video ingestion and video input fits with this category which provides an educational content to the user to ensure the user knows what we are offering to them and how our product can benefit to them.

@faiq-naufal yups mas, I agree with it since it's better in the tutorial one segment and I think it neater if being categorized like that because it's an additional information for developers. I can't think better name though aside from mas advice ('Learn'). Thought of 'Support Articles', but it seems 'Learn' is more compact name.

updates @faiq-naufal & @tyohan :
Screen Shot 2022-06-02 at 09 22 15

Copy link
Contributor

@faiq-naufal faiq-naufal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have some additional reviews, especially with the weight in front matter. Because the weight is important to describe how the menu and page are ordered and sorted. Do you notice in your screenshot if the next page link in the "Learn" page list is not pointing to the "Choosing RTMP vs WebRTC" page? This is because the weight is not ordered properly. Whenever you add a new page or change the page structure, please make sure the pages are already ordered properly.

https://github.com/asumsi/inlive-website/blob/dev/themes/inlive/archetypes/README.md

content/docs/learn/RTMP-vs-webRTC/index.md Outdated Show resolved Hide resolved
content/docs/learn/video-input/index.md Outdated Show resolved Hide resolved
@ingrid011 ingrid011 requested review from tyohan and faiq-naufal June 2, 2022 03:59
@tyohan tyohan merged commit 0d11c83 into dev Jun 3, 2022
@tyohan tyohan deleted the style/glitch-webrtcVSrtmp-tutorial branch June 3, 2022 02:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants