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

Commit

Permalink
Fixed all cross references, fix some typos
Browse files Browse the repository at this point in the history
  • Loading branch information
EraYaN committed Sep 11, 2019
1 parent 15b64b3 commit 971df59
Show file tree
Hide file tree
Showing 13 changed files with 58 additions and 58 deletions.
2 changes: 1 addition & 1 deletion docs/administration/building.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# Building Jellyfin from Source

As an alternative to using [binary packages](/administrator-docs/installing), you can build Jellyfin from source.
As an alternative to using [binary packages](/docs/administration/installing.md), you can build Jellyfin from source.

Jellyfin supports several methods of building for different platforms and instructions for all supported platforms are below.

Expand Down
2 changes: 1 addition & 1 deletion docs/administration/connectivity.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Many clients will automatically discover servers running on the same LAN and dis

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](/administrator-docs/port-forwarding) 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. Please see the [port forwarding](/docs/administration/port-forwarding.md) for more information.

The easiest way to check for issues is by checking the logs, which can be accessed through the settings on the web frontend 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.

Expand Down
4 changes: 2 additions & 2 deletions docs/administration/migrate-from-emby.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Direct database migration from Emby (of any version) to Jellyfin is NOT SUPPORTED. We have found many subtle bugs due to the inconsistent database schemas that result from trying to do this, and strongly recommend that all Jellyfin users migrating from Emby start with a fresh database and library scan.

The original procedure is provided below for reference however we cannot support it nor guarantee that a system upgraded in this way will work properly, if at all. If anyone is interested in writing a database migration script which will correct the deficiencies in the existing database and properly import them into Jellyfin, [we would welcome it however](/contributor-docs/contributing)!
The original procedure is provided below for reference however we cannot support it nor guarantee that a system upgraded in this way will work properly, if at all. If anyone is interested in writing a database migration script which will correct the deficiencies in the existing database and properly import them into Jellyfin, [we would welcome it however](/docs/contributing/index.md)!

## Unofficial procedure

Expand All @@ -23,7 +23,7 @@ This procedure is written for Debian-based Linux distributions, but can be trans
1. Remove or purge the `emby-server` package:
`sudo apt purge emby-server`

1. Install the `jellyfin` package using the [installaton instructions](/administrator-docs/installing).
1. Install the `jellyfin` package using the [installaton instructions](/docs/administration/installing.md).

1. Stop the `jellyfin` daemon:
`sudo service jellyfin stop`
Expand Down
4 changes: 2 additions & 2 deletions docs/administration/quick-start.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Quick-Start

1. [Install Jellyfin on your system](/administrator-docs/installing).
1. [Install Jellyfin on your system](/docs/administration/installing.md).

2. Browse to `http://<yourmachine>:8096`

3. Follow the initial setup wizard.

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](/administrator-docs/reverse-proxy).
* Put your server behind a [reverse proxy](/docs/administration/reverse-proxy.md).
* Only allow local connections and refrain from forwarding any ports.

5. Enjoy your media.
14 changes: 7 additions & 7 deletions docs/clients/clients.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Clients connect your devices to your Jellyfin server and let you view your content on any supported device. You can find a list of clients below with their current development status.

**Note**: Many clients were direct forks of the latest available codebases from Emby, and some are not functional yet. If you interested in helping out, please see our [contribution guide](/contributor-docs/contributing).
**Note**: Many clients were direct forks of the latest available codebases from Emby, and some are not functional yet. If you interested in helping out, please see our [contribution guide](/docs/contributing/index.md).

Do you have a client that interfaces with Jellyfin and want to see it listed here? Please [submit a PR](https://github.com/jellyfin/jellyfin-docs)!

Expand Down Expand Up @@ -73,7 +73,7 @@ A cross-platform desktop media interface using Electron supporting Windows, MacO

A desktop media interface for the Raspberry Pi.

**Status:** ⭕ No Maintainers - [volunteer](/contributor-docs/contributing)
**Status:** ⭕ No Maintainers - [volunteer](/docs/contributing/index.md)

**Links:**

Expand All @@ -83,7 +83,7 @@ A desktop media interface for the Raspberry Pi.

A desktop media interface for Windows.

**Status:** ⭕ No Maintainers - [volunteer](/contributor-docs/contributing)
**Status:** ⭕ No Maintainers - [volunteer](/docs/contributing/index.md)

**Links:**

Expand All @@ -106,7 +106,7 @@ Extension for browsers based on Chromium and Firefox that allows scrobble servic

The official Jellyfin Google Chrome extension.

**Status:** ⭕ No Maintainers - [volunteer](/contributor-docs/contributing)
**Status:** ⭕ No Maintainers - [volunteer](/docs/contributing/index.md)

**Links:**

Expand Down Expand Up @@ -188,7 +188,7 @@ A third party plugin for Mopidy that uses Jellyfin as a backend.

The official Jellyfin Roku app.

**Status:** ❎ Deprecated but salvageable - [major updates required](/contributor-docs/contributing)
**Status:** ❎ Deprecated but salvageable - [major updates required](/docs/contributing/index.md)

**Links:**

Expand All @@ -200,7 +200,7 @@ The official Jellyfin Roku app.

The official Jellyfin Samsung TV app.

**Status:** ⭕ No Maintainers - [volunteer](/contributor-docs/contributing)
**Status:** ⭕ No Maintainers - [volunteer](/docs/contributing/index.md)

**Links:**

Expand All @@ -212,7 +212,7 @@ The official Jellyfin Samsung TV app.

The official Jellyfin Windows Phone app.

**Status:** ❎ Deprecated - [dead platform but salvageable](/contributor-docs/contributing)
**Status:** ❎ Deprecated - [dead platform but salvageable](/docs/contributing/index.md)

**Links:**

Expand Down
4 changes: 2 additions & 2 deletions docs/contributing/contributing-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ The best way to get going is to look through the [Issues list](https://github.co

### Major Issue Types

A list of issue types can be found on the [Issue guidelines](/contributor-docs/issues#issue-labels) page.
A list of issue types can be found on the [Issue guidelines](/docs/contributing/issues.md#issue-labels) page.

### What if there isn't an issue?

If there isn't already an issue dealing with the changes you want to make, please [create an issue](/contributor-docs/issues) to track it first, then ensure your PR(s) reference the issue in question. This is especially useful for bugs that are found and then fixed by the author, so both the original issue and the fix can be documented and tracked in detail.
If there isn't already an issue dealing with the changes you want to make, please [create an issue](/docs/contributing/issues.md) to track it first, then ensure your PR(s) reference the issue in question. This is especially useful for bugs that are found and then fixed by the author, so both the original issue and the fix can be documented and tracked in detail.

## How should you make changes?

Expand Down
8 changes: 4 additions & 4 deletions docs/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,22 @@ Even if you can't contribute code, you can still help Jellyfin! The two main thi

We use GitHub Issues extensively to track open problems, new enhancements or features, and other aspects of the development of Jellyfin.

Please see the [getting help](/user-docs/getting-help) page for help with troubleshooting and finding bugs, and the [documentation on Issues](/contributor-docs/issues) for more information on how to submit good Issues.
Please see the [getting help](/docs/getting-help.md) page for help with troubleshooting and finding bugs, and the [documentation on Issues](/docs/contributing/issues.md) for more information on how to submit good Issues.

## Code

The entire project consists of a C# core server, a Javascript web client, and a number of other clients written in various languages and frameworks. If you have experience with these languages, we're always grateful for any contributions you might want to make!

For general guidelines on how the project works, including how to set up your development copy, make changes, and guidelines on Pull Requests (PRs), please see the [documentation on contributing code](/contributor-docs/contributing-code). Jellyfin follows a "fork and PR" methodology; if you're not familiar with this, please see the [relevant section](/contributor-docs/contributing-code#set-up-your-copy-of-the-repo).
For general guidelines on how the project works, including how to set up your development copy, make changes, and guidelines on Pull Requests (PRs), please see the [documentation on contributing code](/docs/contributing/contributing-code.md). Jellyfin follows a "fork and PR" methodology; if you're not familiar with this, please see the [relevant section](/docs/contributing/contributing-code.md#set-up-your-copy-of-the-repo).

## Documentation

Documentation is incredibly helpful! All these docs are written using `mkdocs` via [readthedocs.io](https://readthedocs.io). You can find the raw markdown in the [documentation repository](https://github.com/jellyfin/jellyfin-docs). Pull requests are welcome!
Documentation is incredibly helpful! All these docs are written using [DocFX](https://dotnet.github.io/docfx/). You can find the raw markdown in the [documentation repository](https://github.com/jellyfin/jellyfin-docs). Pull requests are welcome!

## Translations

If you're interested in helping to translate Jellyfin into your local language, we use [Weblate](https://weblate.org/en/) running at [translate.jellyfin.org](https://translate.jellyfin.org) to handle translations. These are collected in the `translations` branchs of the various repositories and are merged into the `master` branches before each release.

## Testing

Testing is the easiest way to contribute. Simply use Jellyfin, and if you run into problems, [let us know](/user-docs/getting-help). This is the most common way we uncover bugs, through a user doing something we hadn't thought about. If the issue does end up being related to the code, a [bug issue](/contributor-docs/issues#reporting-bugs) can then be opened.
Testing is the easiest way to contribute. Simply use Jellyfin, and if you run into problems, [let us know](/docs/getting-help.md). This is the most common way we uncover bugs, through a user doing something we hadn't thought about. If the issue does end up being related to the code, a [bug issue](/docs/contributing/issues.md#reporting-bugs) can then be opened.
6 changes: 3 additions & 3 deletions docs/contributing/issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Issues should detail software bug reports **only**.

Feature and enhancement requests should be directed towards [our Fider intance](https://features.jellyfin.org) for tracking, voting, and reporting. Please keep all feature requests to this page and not the GitHub issues.

All other discussions, including initial troubleshooting, should be directed towards [our help channels](/user-docs/getting-help).
All other discussions, including initial troubleshooting, should be directed towards [our help channels](/docs/getting-help.md).

## Searching for issues and upvoting

Expand Down Expand Up @@ -34,11 +34,11 @@ When writing an bug issue, please ensure you capture as much relevant detail as

* Any non-standard configurations you use

Bugs should be tagged with `[bug]` at the beginning of their title. This will later be removed by the Jellyfin team when assigning labels. To assist in triaging, if you know which other [label(s)](/contributor-docs/issues#issue-labels) should be applied to your issue, please add them after the `[bug]` label.
Bugs should be tagged with `[bug]` at the beginning of their title. This will later be removed by the Jellyfin team when assigning labels. To assist in triaging, if you know which other [label(s)](/docs/contributing/issues.md#issue-labels) should be applied to your issue, please add them after the `[bug]` label.

Bugs should be reproduceable. That is, you should be able to have determined through troubleshooting how to replicate the issue. While one-time bugs shouldn't be ignored, if they're difficult or impossible to reproduce, it's likely very hard to fix them. Please attempt to reproduce the bug before filing the issue, and include the smallest test case you can to demonstrate it.

If you ever need assistance for troubleshooting or opening an issue, please [contact the community](/user-docs/getting-help) and we'll try to help you out!
If you ever need assistance for troubleshooting or opening an issue, please [contact the community](/docs/getting-help.md) and we'll try to help you out!

## Issue Labels

Expand Down
10 changes: 5 additions & 5 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,26 @@

### Why fork Emby? Why did we start this project?

We explain our rationale on our [about page](/about).
We explain our rationale on our [about page](/docs/about.md).

### My favorite client or feature is missing, why won't you support it?

We would love to support it! Unfortunately, no one has decided to develop it yet, so there isn't much we can do. This is an open source project maintained by developers working entirely in their free time, which usually results in each person working on things they are personally familiar with or plan to use frequently. If you know a developer that would enjoy your favorite feature send them our way, we will gladly help them get familiar with the project workflow!

### How do I get help?

Please see our [getting help](/user-docs/getting-help) page for details on where to engage the community.
Please see our [getting help](/docs/getting-help.md) page for details on where to engage the community.

### How can I help with this project?

Please see our [contributing guide](/contributor-docs/contributing) page for details on how to get started.
Please see our [contributing guide](/docs/contributing/index.md) page for details on how to get started.

We are always looking for C# and frontend developers, mobile app developers, translators, and documentation writers to help!

### How do I request a new feature?

Please see our [requesting features](/contributor-docs/issues#requesting-features) page for details in requesting a new feature in Jellyfin.
Please see our [requesting features](/docs/contributing/issues.md#requesting-features) page for details in requesting a new feature in Jellyfin.

### How do I support this project?

All we can ask is you [use Jellyfin](/administrator-docs/installing), [report any bugs](/contributor-docs/issues#reporting-bugs), and tell your friends about us! Really, we're just people volunteering our time to help build a better media system, so joining the community is the best way to show your support.
All we can ask is you [use Jellyfin](/docs/administration/installing.md), [report any bugs](/docs/contributing/issues.md#reporting-bugs), and tell your friends about us! Really, we're just people volunteering our time to help build a better media system, so joining the community is the best way to show your support.
2 changes: 1 addition & 1 deletion docs/server/transcoding.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ These settings will relate to backend options that modify how the server transco

#### Hardware Acceleration

If your hardware supports this you can enable [hardware acceleration](/administrator-docs/hardware-acceleration) for much faster transcoding. Some of the supported methods are listed below.
If your hardware supports this you can enable [hardware acceleration](/docs/administration/hardware-acceleration.md) for much faster transcoding. Some of the supported methods are listed below.

* VAAPI
* NVENC
Expand Down
2 changes: 1 addition & 1 deletion docs/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
href: administration/migrate-from-emby.md
- name: Plugins
href: administration/plugins.md
- name: Port Binindgs
- name: Port Bindings
href: administration/port-bindings.md
- name: Reverse Proxy
href: administration/reverse-proxy.md
Expand Down
Loading

0 comments on commit 971df59

Please sign in to comment.