From f942715ff1aa18e11a84c960fd6d3d4973a6b61a Mon Sep 17 00:00:00 2001 From: Mark Monteiro Date: Fri, 10 Apr 2020 12:07:50 -0400 Subject: [PATCH 1/5] Set --warningsAsErrors flag in build --- .ci/build-in-ci.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.ci/build-in-ci.ps1 b/.ci/build-in-ci.ps1 index d132fe589..33177e1bf 100644 --- a/.ci/build-in-ci.ps1 +++ b/.ci/build-in-ci.ps1 @@ -1,5 +1,5 @@ choco install docfx -y --version 2.48.1 -docfx docfx.json +docfx --warningsAsErrors docfx.json if ($lastexitcode -ne 0){ throw ("Error generating document") } From 1c5ac56f447d3394534c7a8634352dba86556ae3 Mon Sep 17 00:00:00 2001 From: Mark Monteiro Date: Fri, 10 Apr 2020 12:57:09 -0400 Subject: [PATCH 2/5] Use correct ignore pattern for test projects --- docfx.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docfx.json b/docfx.json index 5c7dae91f..8f25202ab 100644 --- a/docfx.json +++ b/docfx.json @@ -9,7 +9,7 @@ "exclude": [ "**/obj/**", "**/bin/**", - "**/**Test.csproj", + "**/**Tests.csproj", "**/Mono**.csproj", "**/RSSDP.csproj" ], @@ -77,4 +77,4 @@ } } -} \ No newline at end of file +} From 833a2aea8771b0a0e718886e9429f56b1abc7e9d Mon Sep 17 00:00:00 2001 From: Mark Monteiro Date: Fri, 10 Apr 2020 13:24:45 -0400 Subject: [PATCH 3/5] Fix broken links --- general/administration/troubleshooting.md | 2 +- general/quick-start.md | 2 +- index.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/general/administration/troubleshooting.md b/general/administration/troubleshooting.md index c204340e3..5f3e9629f 100644 --- a/general/administration/troubleshooting.md +++ b/general/administration/troubleshooting.md @@ -11,7 +11,7 @@ This page outlines some solutions to common issues beginners may encounter when If you can access the web interface over HTTP but not HTTPS, then you likely have an error with the certificate. Jellyfin uses a PFX file to handle HTTPS traffic. If you created the file with a password, then you will have to enter that value on the **Networking** page in the settings. -If you can access the server locally but not outside of your LAN, then you likely have an issue with the router configuration. Please see the [port forwarding](xref:admin-port-forwarding) page for more information. +If you can access the server locally but not outside of your LAN, then you likely have an issue with the router configuration. Check the port forwarding settings on your router to ensure the server is visible from outside your local network. You can also enable the "Enable automatic port mapping" option on the **Networking** page of the server settings to have the server attempt to configure port forwarding on the router automatically if your router supports it. The easiest way to check for issues is by checking the logs, which can be accessed through the settings on the web client or in the log directory on your server. If there are no logs at all relating to web traffic, even over a LAN connection, then the server hasn't been reached at all yet. This would indicate either an incorrect address or an issue somewhere else on the network. diff --git a/general/quick-start.md b/general/quick-start.md index 14898b0b8..b86b93e48 100644 --- a/general/quick-start.md +++ b/general/quick-start.md @@ -17,7 +17,7 @@ title: Quick Start 4. Secure the server with a method of your choice. * Create an SSL certificate and add it on the **Networking** page. - * Put your server behind a [reverse proxy](xref:admin-reverse-proxy). + * Put your server behind a [reverse proxy](networking/index.md#running-jellyfin-behind-a-reverse-proxy). * Only allow local connections and refrain from forwarding any ports. 5. Enjoy your media! diff --git a/index.md b/index.md index 4082af06c..44f2f6df1 100644 --- a/index.md +++ b/index.md @@ -28,7 +28,7 @@ Note: Jellyfin is a fast moving project that is in its early stages, and this do Want to get starting using Jellyfin right now? Check out the pages below for how to [install Jellyfin](xref:admin-installing) on your machine. -* [Arch](xref:admin-installing#arch) +* [Arch](xref:admin-installing#arch-linux) * [Debian](xref:admin-installing#debian) * [Ubuntu](xref:admin-installing#ubuntu) * [Fedora](xref:admin-installing#fedora) From dcb582ae56bcce570da3879ca0fa2f52d09aa792 Mon Sep 17 00:00:00 2001 From: Mark Monteiro Date: Fri, 10 Apr 2020 13:38:59 -0400 Subject: [PATCH 4/5] Update submodule to latest --- src/jellyfin | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/jellyfin b/src/jellyfin index cb32bf1c4..79f39f733 160000 --- a/src/jellyfin +++ b/src/jellyfin @@ -1 +1 @@ -Subproject commit cb32bf1c4f671c3d4c2ed451d5513ce7d6b2002d +Subproject commit 79f39f7336646758f1797f6fa8c1f7e16c59dfdf From b63b933f9e566a13a2d185b0fe90ca4cda726189 Mon Sep 17 00:00:00 2001 From: Mark Monteiro Date: Fri, 10 Apr 2020 15:10:03 -0400 Subject: [PATCH 5/5] Build server project before running docfx This resolves an issue with external references not being resolved correctly in triple-slash comments: https://github.com/dotnet/docfx/issues/5112#issuecomment-568178162 --- .ci/azure-pipelines.yml | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/.ci/azure-pipelines.yml b/.ci/azure-pipelines.yml index 594d77e15..c940cde80 100644 --- a/.ci/azure-pipelines.yml +++ b/.ci/azure-pipelines.yml @@ -10,7 +10,7 @@ jobs: - job: docs_build displayName: "Main Build" pool: - vmImage: windows-latest + vmImage: windows-latest steps: - checkout: self clean: true @@ -35,6 +35,13 @@ jobs: script: 'git submodule update --recursive --remote' workingDirectory: '$(Build.SourcesDirectory)' + - task: DotNetCoreCLI@2 + displayName: "Build Server Submodule" + inputs: + command: build + arguments: '--configuration Release --source https://api.nuget.org/v3/index.json' + workingDirectory: '$(Build.SourcesDirectory)/src/jellyfin' + - task: PowerShell@2 displayName: "DocFX Build" inputs: @@ -47,18 +54,18 @@ jobs: displayName: "Package Documentation" inputs: rootFolderOrFile: '$(Build.SourcesDirectory)/_site' - includeRootFolder: false + includeRootFolder: false archiveType: 'tar' tarCompression: 'gz' - archiveFile: '$(Build.ArtifactStagingDirectory)/docs-$(Build.BuildId).tar.gz' - replaceExistingArchive: true + archiveFile: '$(Build.ArtifactStagingDirectory)/docs-$(Build.BuildId).tar.gz' + replaceExistingArchive: true - task: GitHubRelease@0 condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'), in(variables['Build.Reason'], 'IndividualCI', 'BatchedCI', 'BuildCompletion')) displayName: "Create GitHub Release" inputs: gitHubConnection: Jellyfin Release Download - repositoryName: '$(Build.Repository.Name)' + repositoryName: '$(Build.Repository.Name)' action: 'create' # Options: create, edit, delete target: '$(Build.SourceVersion)' # Required when action == Create || Action == Edit tagSource: 'manual' # Required when action == Create# Options: auto, manual