Skip to content
This repository has been archived by the owner on Sep 29, 2023. It is now read-only.

RFC-I/001 Doc Proposal #341

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

RFC-I/001 Doc Proposal #341

wants to merge 1 commit into from

Conversation

gewenyu99
Copy link
Contributor

@gewenyu99 gewenyu99 commented Feb 22, 2023

What does this PR do?

This proposes documentation additions for the new video service to be introduced by @Aragur.

Outline

/docs/videos

  • Introduction
    • Describe the purpose of the video service.
    • Outline features of the video service with hyperlinks
    • Suggest some things that can be built with the video service
  • Transcoding Videos
    • Describe how to access the videos tab under storage.
    • Describe available actions in sufficient detail.
      • Create renditions
      • Add Subtitles
    • Programmatic access
      • Client SDK
      • Server SDK
  • Short programatic example to create a video rendition and access it.

We can add sub-pages to document things like a glossary, different codecs, and what ever other details that may be more advanced in concept.

API Reference

The reference will be updated separately in a PR to appwrite/appwrite.

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)

Related PRs and Issues

(If this PR is related to any other PR or resolves any issue or related to any issue link all related PR and issues here.)

Have you read the Contributing Guidelines on issues?

(Write your answer here.)

@eldadfux
Copy link
Member

I feel we should also add some basic terminology. Have a basic explanation about streaming in general, could be part of the main overview.

@gewenyu99
Copy link
Contributor Author

I feel we should also add some basic terminology. Have a basic explanation about streaming in general, could be part of the main overview.

How about we have a basic overview + we can have a sub-page for more in-depth explanation of all the configurable options

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.

2 participants