First step towards DocFX

jellyfin-archive · Sep 11, 2019 · 6d0d266 · 6d0d266
1 parent c979ec2
commit 6d0d266
Show file tree

Hide file tree

Showing 47 changed files with 295 additions and 137 deletions.
diff --git a/.ci/azure-pipelines.yml b/.ci/azure-pipelines.yml
@@ -0,0 +1,26 @@
+name: $(Date:yyyyMMdd)$(Rev:.r)
+
+pr:
+  autoCancel: true
+
+trigger:
+  batch: true
+
+jobs:
+  - job: docs_build
+    displayName: Docs Build
+    pool:
+      vmImage: windows-latest    
+    steps:
+    - checkout: self
+      clean: true
+      submodules: true
+      persistCredentials: false
+
+    - powershell: |
+      choco install docfx -y
+      docfx docfx.json
+      if ($lastexitcode -ne 0){
+        throw ("Error generating document")
+      }
+    displayName: "DocFX Build"
diff --git a/.gitignore b/.gitignore
@@ -1 +1,9 @@
-/site
+###############
+#    folder   #
+###############
+/**/DROP/
+/**/TEMP/
+/**/packages/
+/**/bin/
+/**/obj/
+_site
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "src/jellyfin"]
+	path = src/jellyfin
+	url = https://github.com/jellyfin/jellyfin
diff --git a/docfx.json b/docfx.json
@@ -0,0 +1,76 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "files": [
+            "jellyfin/**.csproj"
+          ],
+          "exclude": [
+            "**/obj/**",
+            "**/bin/**",
+            "**/**Test.csproj",
+            "**/Mono**.csproj",            
+            "**/RSSDP.csproj"
+          ],
+          "src": "src"
+        }
+      ],
+      "dest": "plugin-api",
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "plugin-api/**.yml",
+          "plugin-api/index.md"
+        ]
+      },
+      {
+        "files": [
+          "docs/**.md",
+          "docs/**/toc.yml",
+          "toc.yml",
+          "*.md"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "images/**"
+        ]
+      }
+    ],
+    "dest": "_site",
+    "globalMetadata": {
+      "_appTitle": "Documentation - Jellyfin Project",
+      "_appLogoPath": "images/header-icon.svg",
+      "_appFaviconPath": "images/favicon.png",
+      "_gitContribute": {
+        "repo": "https://github.com/jellyfin/jellyfin-docs",
+        "branch": "master"
+      },
+      "_enableSearch": true
+    },
+    "globalMetadataFiles": [],
+    "fileMetadataFiles": [],
+    "template": [
+      "default"
+    ],
+    "postProcessors": [],
+    "markdownEngineName": "dfm",
+    "noLangKeyword": false,
+    "keepFileLink": false,
+    "cleanupCacheHistory": false,
+    "disableGitFeatures": false
+  },
+  "sitemap":{
+    "baseUrl": "https://docs.jellyfin.org",
+    "priority": 0.1,
+    "changefreq": "daily"
+  }
+}
diff --git a/docs/administrator-docs/building.md → docs/administration/building.md b/docs/administrator-docs/building.md → docs/administration/building.md
diff --git a/docs/administrator-docs/connectivity.md → docs/administration/connectivity.md b/docs/administrator-docs/connectivity.md → docs/administration/connectivity.md
diff --git a/...ministrator-docs/hardware-acceleration.md → docs/administration/hardware-acceleration.md b/...ministrator-docs/hardware-acceleration.md → docs/administration/hardware-acceleration.md
diff --git a/docs/administration/index.md b/docs/administration/index.md
@@ -0,0 +1 @@
+# Server Administration Documentation
diff --git a/docs/administrator-docs/installing.md → docs/administration/installing.md b/docs/administrator-docs/installing.md → docs/administration/installing.md
diff --git a/docs/administrator-docs/migrate-from-emby.md → docs/administration/migrate-from-emby.md b/docs/administrator-docs/migrate-from-emby.md → docs/administration/migrate-from-emby.md
diff --git a/docs/administrator-docs/plugins.md → docs/administration/plugins.md b/docs/administrator-docs/plugins.md → docs/administration/plugins.md
diff --git a/docs/administrator-docs/port-bindings.md → docs/administration/port-bindings.md b/docs/administrator-docs/port-bindings.md → docs/administration/port-bindings.md
diff --git a/docs/administrator-docs/quick-start.md → docs/administration/quick-start.md b/docs/administrator-docs/quick-start.md → docs/administration/quick-start.md
diff --git a/docs/administrator-docs/reverse-proxy.md → docs/administration/reverse-proxy.md b/docs/administrator-docs/reverse-proxy.md → docs/administration/reverse-proxy.md
diff --git a/docs/administration/toc.yml b/docs/administration/toc.yml
@@ -0,0 +1,18 @@
+- name: Quick Start
+  href: quick-start.md
+- name: Installing
+  href: installing.md
+- name: Building
+  href: building.md
+- name: Connectivity
+  href: connectivity.md
+- name: Hardware Acceleration
+  href: hardware-acceleration.md
+- name: Migrate from Emby
+  href: migrate-from-emby.md
+- name: Plugins
+  href: plugins.md
+- name: Port Binindgs
+  href: port-bindings.md
+- name: Reverse Proxy
+  href: reverse-proxy.md
diff --git a/docs/clients.md → docs/clients/index.md b/docs/clients.md → docs/clients/index.md
diff --git a/docs/clients/toc.yml b/docs/clients/toc.yml
@@ -0,0 +1 @@
+[]
diff --git a/docs/contributor-docs/branding-guide.md → docs/contributing/branding-guide.md b/docs/contributor-docs/branding-guide.md → docs/contributing/branding-guide.md
diff --git a/docs/contributor-docs/contributing-code.md → docs/contributing/contributing-code.md b/docs/contributor-docs/contributing-code.md → docs/contributing/contributing-code.md
diff --git a/docs/contributor-docs/contributing.md → docs/contributing/index.md b/docs/contributor-docs/contributing.md → docs/contributing/index.md
diff --git a/docs/contributor-docs/issues.md → docs/contributing/issues.md b/docs/contributor-docs/issues.md → docs/contributing/issues.md
diff --git a/docs/contributor-docs/release-procedure.md → docs/contributing/release-procedure.md b/docs/contributor-docs/release-procedure.md → docs/contributing/release-procedure.md
diff --git a/docs/contributing/toc.yml b/docs/contributing/toc.yml
@@ -0,0 +1,8 @@
+- name: Branding Guide
+  href: branding-guide.md
+- name: Contributing Code
+  href: contributing-code.md
+- name: Issues
+  href: issues.md
+- name: Release Procedure
+  href: release-procedure.md
diff --git a/docs/index.md b/docs/index.md
@@ -1,61 +1 @@
-# Welcome to Jellyfin
-
-<p align="center">
-<img alt="Banner Image" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/branding/SVG/banner-logo-solid.svg?sanitize=true"/>
-<br/><br/>
-<a href="https://github.com/jellyfin/jellyfin"><img class="badge" alt="GPL 2.0 License" src="https://img.shields.io/github/license/jellyfin/jellyfin.svg"/></a>
-<a href="https://github.com/jellyfin/jellyfin/releases"><img class="badge" alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin.svg"/></a>
-<a href="https://translate.jellyfin.org/engage/jellyfin/?utm_source=widget"><img class="badge" alt="Translations" src="https://translate.jellyfin.org/widgets/jellyfin/-/svg-badge.svg"/></a>
-<a href="https://cloud.drone.io/jellyfin/jellyfin"><img class="badge" alt="Build Status" src="https://cloud.drone.io/api/badges/jellyfin/jellyfin/status.svg"/></a>
-<a href="https://hub.docker.com/r/jellyfin/jellyfin"><img class="badge" alt="Docker Pull Count" src="https://img.shields.io/docker/pulls/jellyfin/jellyfin.svg"/></a>
-</br>
-<a href="https://opencollective.com/jellyfin"><img class="badge" alt="Donate" src="https://img.shields.io/opencollective/all/jellyfin.svg?label=backers"/></a>
-<a href="https://forum.jellyfin.org"/><img class="badge" alt="Discuss on our Forum" src="https://img.shields.io/discourse/https/forum.jellyfin.org/users.svg"/></a>
-<a href="https://matrix.to/#/+jellyfin:matrix.org"><img class="badge" alt="Chat on Matrix" src="https://img.shields.io/matrix/jellyfin:matrix.org.svg?logo=matrix"/></a>
-<a href="https://www.reddit.com/r/jellyfin/"><img class="badge" alt="Join our Subreddit" src="https://img.shields.io/badge/reddit-r%2Fjellyfin-%23FF5700.svg"/></a>
-</p>
-
-Jellyfin is a Free Software Media System that puts you in control of managing and streaming your media. It is an alternative to the proprietary Emby and Plex, to provide media from a dedicated server to end-user devices via multiple apps. Jellyfin is descended from Emby's 3.5.2 release and ported to the .NET Core framework to enable full cross-platform support. There are no strings attached, no premium licenses or features, and no hidden agendas: just a team who want to build something better and work together to achieve it. We welcome anyone who is interested in joining us in our quest!
-
-You can find a list of all available clients [here](/clients). For more information please see our [about page](/about) or the [FAQ](/faq). If you are looking for help, check out [this page](/getting-help) for all the different communication channels we use.
-
-Note: Jellyfin is a fast moving project that is in its early stages, and this documentation as well as the code may change frequently. Please check back often and don't hesitate to contact us via our Matrix channels or the subreddit!
-
-## Getting Started
-
-Want to get starting using Jellyfin right now? Check out the pages below for how to [install Jellyfin](/administrator-docs/installing) on your machine.
-
-* [Arch](/administrator-docs/installing#arch)
-* [Debian](/administrator-docs/installing#debian)
-* [Ubuntu](/administrator-docs/installing#ubuntu)
-* [Fedora](/administrator-docs/installing#fedora)
-* [CentOS](/administrator-docs/installing#centos)
-* [Docker](/administrator-docs/installing#docker-hub)
-* [unRaid](/administrator-docs/installing#unraid-docker)
-* [Kubernetes](/administrator-docs/installing#kubernetes)
-* [Windows](/administrator-docs/installing#windows-x64x86)
-* [MacOS](/administrator-docs/installing#macos)
-* [Generic Linux](/administrator-docs/installing#linux-generic-amd64)
-* [Portable DLL](/administrator-docs/installing#portable-dll)
-
-Alternatively, Jellyfin may be built directly from the [source code](/administrator-docs/building).
-
-## Administrator Documentation
-
-Want to know more about administering a Jellyfin server? Check out these pages!
-
-* [Quick-Start Guide](/administrator-docs/quick-start): What to do after you've installed Jellyfin to get it up and running.
-* [Migrating from Emby](/administrator-docs/migrate-from-emby): How to migrate an existing Emby 3.5.2 installation to Jellyfin.
-* [Plugins](/administrator-docs/plugins): How to install plugins in Jellyfin.
-* [Port Bindings](/administrator-docs/port-bindings)
-* [Hardware Acceleration](/administrator-docs/hardware-acceleration)
-
-## Contributing to Jellyfin
-
-Want to help out? Check out the pages below for how to contribute.
-
-* [Contribution Guide](/contributor-docs/contributing): General information on contributing to Jellyfin.
-* [Plugin Guide](https://github.com/jellyfin/jellyfin-plugin-template): Documentation and resources to get started writing a plugin to extend Jellyfin functionality.
-* [Reporting Bugs](/contributor-docs/issues#reporting-bugs): How to use our issue tracker on GitHub to report bugs.
-* [Requesting Features](/contributor-docs/issues#requesting-features): How to use our issue tracker on GitHub to request new features or enhancements.
-* [Coding Style](/contributor-docs/coding-style): Code and naming style guide.
+# User Documentation
diff --git a/docs/server/index.md b/docs/server/index.md
diff --git a/docs/media/cloud-storage.md → docs/server/media/cloud-storage.md b/docs/media/cloud-storage.md → docs/server/media/cloud-storage.md
diff --git a/docs/server/media/index.md b/docs/server/media/index.md
diff --git a/docs/media/movies.md → docs/server/media/movies.md b/docs/media/movies.md → docs/server/media/movies.md
diff --git a/docs/media/music.md → docs/server/media/music.md b/docs/media/music.md → docs/server/media/music.md
diff --git a/docs/media/shows.md → docs/server/media/shows.md b/docs/media/shows.md → docs/server/media/shows.md
diff --git a/docs/media/subtitles.md → docs/server/media/subtitles.md b/docs/media/subtitles.md → docs/server/media/subtitles.md
diff --git a/docs/server/media/toc.yml b/docs/server/media/toc.yml
@@ -0,0 +1,10 @@
+- name: Cloud Storage
+  href: cloud-storage.md
+- name: Movies
+  href: movies.md
+- name: Music
+  href: music.md
+- name: Shows
+  href: shows.md
+- name: Subtitles
+  href: subtitles.md
diff --git a/docs/server/plugins.md → docs/server/plugins/index.md b/docs/server/plugins.md → docs/server/plugins/index.md
diff --git a/docs/plugins/open-subtitles.md → docs/server/plugins/open-subtitles.md b/docs/plugins/open-subtitles.md → docs/server/plugins/open-subtitles.md
diff --git a/docs/server/plugins/toc.yml b/docs/server/plugins/toc.yml
@@ -0,0 +1,4 @@
+- name: Open Subtitles
+  href: open-subtitles.md
+- name: TVHeadend
+  href: tvheadend.md
diff --git a/docs/plugins/tvheadend.md → docs/server/plugins/tvheadend.md b/docs/plugins/tvheadend.md → docs/server/plugins/tvheadend.md
diff --git a/docs/server/toc.yml b/docs/server/toc.yml
@@ -0,0 +1,22 @@
+- name: Media
+  href: media/
+  homepage: media/index.md
+- name: Plugins
+  href: plugins/
+  homepage: plugins/index.md
+- name: Devices
+  href: devices.md
+- name: Libraries
+  href: libraries.md
+- name: Live TV
+  href: live-tv.md
+- name: Notifications
+  href: notifications.md
+- name: Settings
+  href: settings.md
+- name: Tasks
+  href: tasks.md
+- name: Transcoding
+  href: transcoding.md
+- name: Users
+  href: users.md
diff --git a/docs/static/overrides.css b/docs/static/overrides.css
diff --git a/docs/toc.yml b/docs/toc.yml
@@ -0,0 +1,12 @@
+- name: Clients
+  href: clients/
+  homepage: clients/index.md
+- name: Server
+  href: server/
+  homepage: server/index.md
+- name: Administration
+  href: administration/
+  homepage: administration/index.md
+- name: Contributing
+  href: contributing/
+  homepage: contributing/index.md
diff --git a/images/favicon.png b/images/favicon.png
diff --git a/images/header-icon.svg b/images/header-icon.svg
diff --git a/index.md b/index.md
@@ -0,0 +1,61 @@
+# Welcome to the Jellyfin Documentation
+
+<p align="center">
+<img alt="Banner Image" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/branding/SVG/banner-logo-solid.svg?sanitize=true"/>
+<br/><br/>
+<a href="https://github.com/jellyfin/jellyfin"><img class="badge" alt="GPL 2.0 License" src="https://img.shields.io/github/license/jellyfin/jellyfin.svg"/></a>
+<a href="https://github.com/jellyfin/jellyfin/releases"><img class="badge" alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin.svg"/></a>
+<a href="https://translate.jellyfin.org/engage/jellyfin/?utm_source=widget"><img class="badge" alt="Translations" src="https://translate.jellyfin.org/widgets/jellyfin/-/svg-badge.svg"/></a>
+<a href="https://cloud.drone.io/jellyfin/jellyfin"><img class="badge" alt="Build Status" src="https://cloud.drone.io/api/badges/jellyfin/jellyfin/status.svg"/></a>
+<a href="https://hub.docker.com/r/jellyfin/jellyfin"><img class="badge" alt="Docker Pull Count" src="https://img.shields.io/docker/pulls/jellyfin/jellyfin.svg"/></a>
+</br>
+<a href="https://opencollective.com/jellyfin"><img class="badge" alt="Donate" src="https://img.shields.io/opencollective/all/jellyfin.svg?label=backers"/></a>
+<a href="https://forum.jellyfin.org"/><img class="badge" alt="Discuss on our Forum" src="https://img.shields.io/discourse/https/forum.jellyfin.org/users.svg"/></a>
+<a href="https://matrix.to/#/+jellyfin:matrix.org"><img class="badge" alt="Chat on Matrix" src="https://img.shields.io/matrix/jellyfin:matrix.org.svg?logo=matrix"/></a>
+<a href="https://www.reddit.com/r/jellyfin/"><img class="badge" alt="Join our Subreddit" src="https://img.shields.io/badge/reddit-r%2Fjellyfin-%23FF5700.svg"/></a>
+</p>
+
+Jellyfin is a Free Software Media System that puts you in control of managing and streaming your media. It is an alternative to the proprietary Emby and Plex, to provide media from a dedicated server to end-user devices via multiple apps. Jellyfin is descended from Emby's 3.5.2 release and ported to the .NET Core framework to enable full cross-platform support. There are no strings attached, no premium licenses or features, and no hidden agendas: just a team who want to build something better and work together to achieve it. We welcome anyone who is interested in joining us in our quest!
+
+You can find a list of all available clients [here](/clients). For more information please see our [about page](/about) or the [FAQ](/faq). If you are looking for help, check out [this page](/getting-help) for all the different communication channels we use.
+
+Note: Jellyfin is a fast moving project that is in its early stages, and this documentation as well as the code may change frequently. Please check back often and don't hesitate to contact us via our Matrix channels or the subreddit!
+
+## Getting Started
+
+Want to get starting using Jellyfin right now? Check out the pages below for how to [install Jellyfin](/administrator-docs/installing) on your machine.
+
+* [Arch](/administrator-docs/installing#arch)
+* [Debian](/administrator-docs/installing#debian)
+* [Ubuntu](/administrator-docs/installing#ubuntu)
+* [Fedora](/administrator-docs/installing#fedora)
+* [CentOS](/administrator-docs/installing#centos)
+* [Docker](/administrator-docs/installing#docker-hub)
+* [unRaid](/administrator-docs/installing#unraid-docker)
+* [Kubernetes](/administrator-docs/installing#kubernetes)
+* [Windows](/administrator-docs/installing#windows-x64x86)
+* [MacOS](/administrator-docs/installing#macos)
+* [Generic Linux](/administrator-docs/installing#linux-generic-amd64)
+* [Portable DLL](/administrator-docs/installing#portable-dll)
+
+Alternatively, Jellyfin may be built directly from the [source code](/administrator-docs/building).
+
+## Administrator Documentation
+
+Want to know more about administering a Jellyfin server? Check out these pages!
+
+* [Quick-Start Guide](/administrator-docs/quick-start): What to do after you've installed Jellyfin to get it up and running.
+* [Migrating from Emby](/administrator-docs/migrate-from-emby): How to migrate an existing Emby 3.5.2 installation to Jellyfin.
+* [Plugins](/administrator-docs/plugins): How to install plugins in Jellyfin.
+* [Port Bindings](/administrator-docs/port-bindings)
+* [Hardware Acceleration](/administrator-docs/hardware-acceleration)
+
+## Contributing to Jellyfin
+
+Want to help out? Check out the pages below for how to contribute.
+
+* [Contribution Guide](/contributor-docs/contributing): General information on contributing to Jellyfin.
+* [Plugin Guide](https://github.com/jellyfin/jellyfin-plugin-template): Documentation and resources to get started writing a plugin to extend Jellyfin functionality.
+* [Reporting Bugs](/contributor-docs/issues#reporting-bugs): How to use our issue tracker on GitHub to report bugs.
+* [Requesting Features](/contributor-docs/issues#requesting-features): How to use our issue tracker on GitHub to request new features or enhancements.
+* [Coding Style](/contributor-docs/coding-style): Code and naming style guide.