Moved docs/ to general/. Adjusted the base URL. Added final CI touches.

jellyfin-archive · Sep 14, 2019 · e3cc856 · e3cc856
1 parent 683344c
commit e3cc856
Show file tree

Hide file tree

Showing 39 changed files with 40 additions and 14 deletions.
diff --git a/.ci/azure-pipelines.yml b/.ci/azure-pipelines.yml
@@ -15,12 +15,38 @@ jobs:
     - checkout: self
       clean: true
       submodules: true
-      persistCredentials: false
+      persistCredentials: true
 
-    - powershell: |
-      choco install docfx -y
-      docfx docfx.json
-      if ($lastexitcode -ne 0){
-        throw ("Error generating document")
-      }
-    displayName: "DocFX Build"
+    - task: PowerShell@2
+      displayName: "DocFX Build"
+      inputs:
+        targetType: 'inline'        
+        script: 'choco install docfx -y
+          docfx docfx.json
+          if ($lastexitcode -ne 0){
+            throw ("Error generating document")
+          }'
+
+    - task: CmdLine@2
+      displayName: "Clone Website"
+      inputs:
+        script: 'git clone https://github.com/jellyfin/jellyfin.github.io jellyfin.github.io' 
+        workingDirectory: '$(Build.ArtifactStagingDirectory)'
+        #failOnStderr: false # Optional
+
+    - task: CopyFiles@2
+      inputs:
+        sourceFolder: '$(Build.SourcesDirectory)/_site'
+        contents: '**' 
+        targetFolder: '$(Build.ArtifactStagingDirectory)/jellyfin.github.io/docs'
+        cleanTargetFolder: true # Optional
+        overWrite: true # Optional
+        #flattenFolders: false # Optional
+        #preserveTimestamp: false # Optional
+
+    - task: CmdLine@2
+      displayName: "Add files to website"
+      inputs:
+        script: 'git add docs && git commit -m "Documentation update" && git push origin' 
+        workingDirectory: '$(Build.ArtifactStagingDirectory)/jellyfin.github.io'
+        #failOnStderr: false # Optional
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ Describe all available API surfaces and class from plugin development.
 ## Docs
 `docs` is the main custom documentation directory.
 All uids for the custom documentation are relative to this directory, with `administration` and `contributing` shortened to `admin` and `contrib` respectively.
-So for example to reference the file `docs/administration/installing.md` one would use `xref:admin-installing` with an optional anchor like `xref:admin-installing#arch`.
+So for example to reference the file `general/administration/installing.md` one would use `xref:admin-installing` with an optional anchor like `xref:admin-installing#arch`.
 
 ### Administration
 

diff --git a/docfx.json b/docfx.json
@@ -31,8 +31,8 @@
       },
       {
         "files": [
-          "docs/**.md",
-          "docs/**/toc.yml",
+          "general/**.md",
+          "general/**/toc.yml",
           "toc.yml",
           "index.md"
         ]
@@ -70,7 +70,7 @@
     "cleanupCacheHistory": false,
     "disableGitFeatures": false,
     "sitemap":{
-      "baseUrl": "https://docs.jellyfin.org",
+      "baseUrl": "https://jellyfin.org/docs/",
       "priority": 0.1,
       "changefreq": "daily"
     }

diff --git a/docs/about.md → general/about.md b/docs/about.md → general/about.md
diff --git a/docs/administration/building.md → general/administration/building.md b/docs/administration/building.md → general/administration/building.md
diff --git a/docs/administration/connectivity.md → general/administration/connectivity.md b/docs/administration/connectivity.md → general/administration/connectivity.md
diff --git a/docs/administration/hardware-acceleration.md → ...l/administration/hardware-acceleration.md b/docs/administration/hardware-acceleration.md → ...l/administration/hardware-acceleration.md
diff --git a/docs/administration/installing.md → general/administration/installing.md b/docs/administration/installing.md → general/administration/installing.md
diff --git a/docs/administration/migrate-from-emby.md → general/administration/migrate-from-emby.md b/docs/administration/migrate-from-emby.md → general/administration/migrate-from-emby.md
diff --git a/docs/administration/port-bindings.md → general/administration/port-bindings.md b/docs/administration/port-bindings.md → general/administration/port-bindings.md
diff --git a/docs/administration/quick-start.md → general/administration/quick-start.md b/docs/administration/quick-start.md → general/administration/quick-start.md
diff --git a/docs/administration/reverse-proxy.md → general/administration/reverse-proxy.md b/docs/administration/reverse-proxy.md → general/administration/reverse-proxy.md
diff --git a/docs/clients/clients.md → general/clients/clients.md b/docs/clients/clients.md → general/clients/clients.md
diff --git a/docs/contributing/branding-guide.md → general/contributing/branding-guide.md b/docs/contributing/branding-guide.md → general/contributing/branding-guide.md
diff --git a/docs/contributing/development.md → general/contributing/development.md b/docs/contributing/development.md → general/contributing/development.md
diff --git a/docs/contributing/index.md → general/contributing/index.md b/docs/contributing/index.md → general/contributing/index.md
diff --git a/docs/contributing/issues.md → general/contributing/issues.md b/docs/contributing/issues.md → general/contributing/issues.md
diff --git a/docs/contributing/release-procedure.md → general/contributing/release-procedure.md b/docs/contributing/release-procedure.md → general/contributing/release-procedure.md
diff --git a/docs/faq.md → general/faq.md b/docs/faq.md → general/faq.md
diff --git a/docs/getting-help.md → general/getting-help.md b/docs/getting-help.md → general/getting-help.md
diff --git a/docs/index.md → general/index.md b/docs/index.md → general/index.md
diff --git a/docs/server/devices.md → general/server/devices.md b/docs/server/devices.md → general/server/devices.md
diff --git a/docs/server/libraries.md → general/server/libraries.md b/docs/server/libraries.md → general/server/libraries.md
diff --git a/docs/server/live-tv.md → general/server/live-tv.md b/docs/server/live-tv.md → general/server/live-tv.md
diff --git a/docs/server/media/cloud-storage.md → general/server/media/cloud-storage.md b/docs/server/media/cloud-storage.md → general/server/media/cloud-storage.md
diff --git a/docs/server/media/movies.md → general/server/media/movies.md b/docs/server/media/movies.md → general/server/media/movies.md
diff --git a/docs/server/media/music.md → general/server/media/music.md b/docs/server/media/music.md → general/server/media/music.md
diff --git a/docs/server/media/shows.md → general/server/media/shows.md b/docs/server/media/shows.md → general/server/media/shows.md
diff --git a/docs/server/media/subtitles.md → general/server/media/subtitles.md b/docs/server/media/subtitles.md → general/server/media/subtitles.md
diff --git a/docs/server/notifications.md → general/server/notifications.md b/docs/server/notifications.md → general/server/notifications.md
diff --git a/docs/server/plugins/index.md → general/server/plugins/index.md b/docs/server/plugins/index.md → general/server/plugins/index.md
diff --git a/docs/server/plugins/open-subtitles.md → general/server/plugins/open-subtitles.md b/docs/server/plugins/open-subtitles.md → general/server/plugins/open-subtitles.md
diff --git a/docs/server/plugins/tvheadend.md → general/server/plugins/tvheadend.md b/docs/server/plugins/tvheadend.md → general/server/plugins/tvheadend.md
diff --git a/docs/server/settings.md → general/server/settings.md b/docs/server/settings.md → general/server/settings.md
diff --git a/docs/server/tasks.md → general/server/tasks.md b/docs/server/tasks.md → general/server/tasks.md
diff --git a/docs/server/transcoding.md → general/server/transcoding.md b/docs/server/transcoding.md → general/server/transcoding.md
diff --git a/docs/server/users.md → general/server/users.md b/docs/server/users.md → general/server/users.md
diff --git a/docs/toc.yml → general/toc.yml b/docs/toc.yml → general/toc.yml
diff --git a/toc.yml b/toc.yml
@@ -1,5 +1,5 @@
 - uid: general-docs
-  href: docs/
+  href: general/
 - uid: plugin-api-docs
   href: plugin-api/
 - uid: getting-help
@@ -8,4 +8,4 @@
 - name: GitHub
   href: https://github.com/jellyfin
 - name: Website
-  href: https://jellyfin.media
+  href: https://jellyfin.org