jellyfin/jellyfin.org
1
0
Fork 0
mirror of https://github.com/jellyfin/jellyfin.org.git synced 2026-09-03 04:00:06 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation policies page & PR template (#1594)

Browse Source 
* Add documentation policies page

* Add pull request template

* Add note of blog posts

* Fix and add links

* Fix link to Framapad

Co-authored-by: felix920506 <felix920506@gmail.com>

* Adjust wording of peer review section

Co-authored-by: Niels van Velzen <nielsvanvelzen@users.noreply.github.com>

* Add core review blurb

* Add mention of publishing date

* Update .github/pull_request_template.md

Co-authored-by: Niels van Velzen <nielsvanvelzen@users.noreply.github.com>

* Update docs/general/contributing/documentation.md

Co-authored-by: BotBlake <B0TBlake@protonmail.com>

* Fix bad links

* Fix links

---------

Co-authored-by: felix920506 <felix920506@gmail.com>
Co-authored-by: Niels van Velzen <nielsvanvelzen@users.noreply.github.com>
Co-authored-by: BotBlake <B0TBlake@protonmail.com>
This commit is contained in:
Joshua M. Boniface
2025-10-13 13:33:34 -04:00
committed by GitHub
co-authored by felix920506 Niels van Velzen BotBlake
parent a9f8d60439
commit d2359c9c06
4 changed files with 135 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/pull_request_template.md
+24
View File
@@ -0,0 +1,24 @@
<!--
Thank you for contributing to our documentation. We receive a lot of pull requests here, so we want to streamline this process.
-->
**Changes**
<!-- Describe a little about what you've changed and why. -->
**Copyediting**
To avoid "nitpicky" reviews, please ensure all of the following have been done for any non-trivial changes.
- [ ] I have run this PR [through a spellchecker](https://jellyfin.org/docs/general/contributing/documentation#please-self-review) (e.g. `aspell`).
- [ ] I have re-read my PR at least twice and fixed any obvious mistakes I see.
- [ ] I have received [out-of-band peer copyediting](https://jellyfin.org/docs/general/contributing/documentation#peer-copyediting) from someone in [#jellyfin-documentation](https://matrix.to/#/#jellyfin-documentation:matrix.org).
While you're waiting for someone to look at your pull request, How about looking at another one? You do not have to do this, but it will help ensure your PR is reviewed quickly in turn.
- [ ] I have provided [a *substantive* review of another documentation PR](https://jellyfin.org/docs/general/contributing/documentation#peer-reviews).
**Issues**
<!-- If applicable, please list any open issues that this PR addresses -->
<!-- e.g. -->
<!-- - closes #1234 -->
docs/general/contributing/documentation.md
+30
View File
@@ -0,0 +1,30 @@
---
uid: documentation
title: Contributing to Documentation
---
# Contributing to Documentation
## What to change and Why
Documentation is fast-moving and ever-changing. Please think carefully about what you're changing and why; what will it contribute going forward? Extensive rewrites and new pages should be considered very carefully and coordinated in our [documentation Matrix room](/contact).
## Please Self-Review
Before finalizing your changes, please be courteous to reviewers and run your changes through, at least, a spellchecker (e.g. `apsell`) and potentially a grammar checker. AI is fine for this though please use it sparingly for *generating* content. Make sure you re-read what comes out and adjust as required. We appreciate individual writing styles but the bulk of our review back-and-forth is over minor issues like this, so please do your part to get it right first.
## Peer Copyediting
For very large changes, we encourage the idea of peer copyediting. Instead of submitting a massive PR and then having back-and-forth line-by-line editing in there, we suggest placing your new/updated doc in a collaborative document editor such as [Framapad](https://framapad.org/abc/en/) and sharing it in our [documentation Matrix room](/contact). You can then, between chat and the collaborative editor, obtain a line-by-line copyedit for spelling, grammar, and formatting, without back-and-forth in the PR. Once both sides are happy with the changes, a pull request can then be submitted.
While this does seem like "more work", for substantial changes this should ideally be a small part of the entire process, and will help ensure that final reviews go more smoothly.
## Peer Reviews
Due to the volume of pull requests to our documentation repo and the varying sizes of them, some pull requests will take a long time to review, and potentially languish as a result.
Before (or, immediately after) submitting a PR for review, we ask you to find another PR from another person, ideally one which is not already peer- or team-reviewed, and perform a thorough readthrough of the changes. Make sure they make sense to you, that the copyediting is good, and provide a GitHub review of it. If necessary please point out any change suggestions. This will help go a long way to helping your PR be reviewed, as the next contributor can review your PR in turn.
## Blog Posts
Blog posts are exclusively written by our team members; we do not accept outside blog posts under any circumstances. Blog posts should follow all the above processes, and further require final approval from the Core team in addition to regular documentation approvers. Blog posts may stay in draft or review status for some time, until the event they correlate with (e.g. a release); the date should always reflect the final (expected) publishing date.
docs/general/contributing/index.md
+1 -1
View File
@@ -23,7 +23,7 @@ For general guidelines on how the project works, including how to set up your de
## Adding To Documentation
Documentation is incredibly helpful! All these docs are written using [Docusaurus](https://docusaurus.io/docs/markdown-features). You can find the raw markdown in the [documentation repository](https://github.com/jellyfin/jellyfin.org). Pull requests are welcome!
Documentation is incredibly helpful! All these docs are written using [Docusaurus](https://docusaurus.io/docs/markdown-features). You can find the raw markdown in the [documentation repository](https://github.com/jellyfin/jellyfin.org). Pull requests are welcome, though please review our [documentation process](/docs/general/contributing/documentation) first!
## Translating
docs/project/branding.md
+80
View File
@@ -0,0 +1,80 @@
---
uid: contrib-branding
title: Branding
---
# Branding
## Usage of the Jellyfin name & logo
The name "Jellyfin" and the primary logo (two integrated triangular shapes, a stylized "fin") are trademarks in Canada, the United States, the European Union, and China of "Jellyfin, Inc.", an Ontario, Canada-based not-for-profit corporation.
A perpetual, no cost license is hereby granted to all members of the Jellyfin organization ("team") and projects under [our GitHub account](https://github.com/jelyfin) to use the name and logo in furtherance of the Jellyfin project.
For all others, you are **not** free to use the name "Jellyfin" or our logo without the explicit permission of the [project leadership team](/docs/general/about#core-team), with the following exceptions:
- Any instance of the Jellyfin software running for any purpose **accessible for no fee to its users** is granted an implicit license to use the name and logo for that purpose. If you charge for access to your server in any form, you are **required to change the branding of the server** in some way to clearly identify that the server owner is not "Jellyfin" as a project, and provide at least one method of contact for the server. For Jellyfin 10.10.x or before, you may use the Login Disclaimer field for this purpose; for Jellyfin 10.11.x and newer, you may use the Login Disclaimer and/or change the logo and name of the instance for this purpose. For example, a login disclaimer such as `This server is run by https://someprovider.org. For assistance, please see https://someprovider.org/contact.` is acceptable.
- The name "Jellyfin" **may** be used within another project as an affix to demonstrate compatibility; for example "_Awesome Client for Jellyfin_" is permitted. You may **not** use the name directly, in a way that makes the program appear to be an official client; for example "_Jellyfin MyPlatform_" is not permitted. Using subcomponents of the name (i.e. "Jelly", or "fin") coupled with additional words are permitted; for example, "Jellyseer", "Audiofin", or the like.
- All 3rd party projects **should** use their own logo to clearly differentiate it, but **exceptions may be granted** for free-and-libre-open-source (FLOSS) projects by contacting the leadership team, with a goal towards official project status. The logo *colours* are not subject to trademark, and the purple-blue gradient theme may be used with another logo shape for identification as part of the Jellyfin ecosystem without limitation.
- Any **fork** of Jellyfin or an official client application for public distribution **must** use a different name and logo.
- The name "Jellyfin" and the logo **may** be used to describe or name communities or groups for users of the software, for instance community groups on social media or other sites.
- The name "Jellyfin" and the logo **may** be used to describe the program in any form of media without restriction.
- Any other uses shall be judged on a good-faith basis; if unsure, please contact the leadership team for advice.
## Writing Style
The name "Jellyfin" is always written thus. It is not "JellyFin", "Jelly Fin", or any similar form.
As a general rule, "Jellyfin" should always be capitalized, but language, file, or system conventions may trump this convention. Specific examples include:
- Writing referring to the project in the abstract should use capitalized `Jellyfin` at all times. `I contribute to Jellyfin and you should too!`
- C# class and project names, including their files and directories, should use capitalized `Jellyfin` as required by the C# case standards (camelCase or PascalCase). `Jellyfin.LiveTv`, `Jellyfin.sln`
- Other code elements, where the code formatting or style requires lowercase, should use lowercase `jellyfin`. `jellyfinWebComponentsBowerPath`
- The Git repository and non-C# files inside of it should use lowercase `jellyfin` for convenience on case-sensitive filesystems. `build-jellyfin.ps1`
- The final output binary, initscrips, and package names should use lowercase `jellyfin` for similar reasons as above. `jellyfin.dll`, `jellyfin_3.5.2-1_all.deb`, `jellyfin.zip`
- Configuration directories can use either depending on operating system conventions. `/var/lib/jellyfin`, `AppData/Jellyfin`
- The logo has no strict rules for capitalization, the style is dependent on aesthetics and font choice.
## Icons and Visual Assets
:::warning
Jellyfin is currently rebranding, as such these guidelines (including the logo) are outdated. Join our [#jellyfin-ui-ux](https://matrix.to/#/#jellyfin-ui-ux:matrix.org) chat on Matrix for any questions.
:::
All iconography and other resources can be found in the [jellyfin-ux](https://github.com/jellyfin/jellyfin-ux) repository.
- Icons
- Banners
- Fonts
### Logo
When using the full version of the logo, the text should only be placed to the right of the icon.
![The logo should have the text placed on the right of the icon.](/images/docs/branding-logo-yes-side.png#hidden--dark-mode)
![The logo should have the text placed on the right of the icon.](/images/docs/branding-logo-dark-theme-yes-side.png#hidden--light-mode)
![The logo should never have the text placed below the icon.](/images/docs/branding-logo-no-below.png#hidden--dark-mode)
![The logo should never have the text placed below the icon.](/images/docs/branding-logo-dark-theme-no-below.png#hidden--light-mode)
The design for the logo uses a gradient for the infill, and if the non-transparent logo is chosen there is an optional background color.
- Gradient Start: `#AA5CC3`
- Gradient End: `#00A4DC`
- Background Color: `#000B25`
### Theme
- Background Color: `#101010`
- Accent Color: `#00A4DC`
### Fonts
The banner uses the [Plus Jakarta Sans](https://fonts.google.com/specimen/Plus+Jakarta+Sans) font.