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

Developer website task collection #447

Open
2 of 11 tasks
nielsvanvelzen opened this issue Mar 15, 2023 · 6 comments
Open
2 of 11 tasks

Developer website task collection #447

nielsvanvelzen opened this issue Mar 15, 2023 · 6 comments

Comments

@nielsvanvelzen
Copy link
Member

nielsvanvelzen commented Mar 15, 2023

I've started work on a developer site in the "developers" branch some time ago. This list collects all tasks that need to happen before & after launch of the site. We'll launch the site with minimal content and we can add more over time. The main tasks left are UX related. If you want to work on one of these things please comment/notify in Matrix to avoid several people working on the same thing.

Before launch

Note: this list is outdated and needs updating. I will do this as soon as I have some extra time.

  • Somehow merge the developer docs and developer blog, some ideas:
    • Add recent blog posts to sidebar for docs, use that sidebar for blog posts
    • Add a second header menu beneath the existing one to easily switch between blog/docs, this menu could also contain the current Jellyfin version or something
  • Show announcement banner indicating the developer site is still a work in progress
    This should ONLY show on the pages for the development site, not on the end-user docs/blog
  • Add an developer index page (Add index page for developers site #466)

After launch

  • Add page for Authentication (how to get an access token with QuickConnect/AuthenticateByName/etc)
  • Add page for getting started with plugin dev
    • Add page describing the plugin repository format (maybe add a JSON schema?)
    • Add page describing the plugin meta format (maybe add a JSON schema?)
  • Add page listing our SDK's
  • Add page with API changelog (based on the kotlin-sdk openapi-generator compare tool)
  • Add page listing contact persons for various roles (app publishing, security issues) and maintainers (SDKs & clients)
  • Add page for the playback APIs
@ferferga
Copy link
Member

Can we also have some specific docs for playback requests maybe? The whole get mediasource and start a playback session it's huge black box, even to me.

@nielsvanvelzen
Copy link
Member Author

Can we also have some specific docs for playback requests maybe? The whole get mediasource and start a playback session it's huge black box, even to me.

I've added it but I have no clue how they work myself either so that's why I didn't list it originally (the list is basically the to do I made for myself posted as an issue :p)

@mcarlton00
Copy link
Member

In regards to the authentication, I have this gist for username/password that can probably just be forklifted into wherever in the docs in belongs: https://gist.github.com/mcarlton00/f7bd7218828ed465ce0f309cebf9a247

@nielsvanvelzen
Copy link
Member Author

We can probably re-use most of the Kotlin SDK's authentication page too: https://kotlin-sdk.jellyfin.org/guide/authentication.html

@nielsvanvelzen
Copy link
Member Author

Closing due to lack of interest

@nielsvanvelzen nielsvanvelzen closed this as not planned Won't fix, can't repro, duplicate, stale Jul 29, 2023
@sevenrats
Copy link
Member

I'm intereested, but unfortunately, all I can offer is time and interest. I'm reasonably ignorant to the layout of the code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants