Skip to content

Commit 0eea8a5

Browse files
authored
Remove links to old Wiki (#1793)
* Remove links to old Wiki. Fixes #1660 Also remove references to CIC and CLA, and other content where a more recent version exists on the documentation site. * Remove more obsolete links.
1 parent 728885f commit 0eea8a5

10 files changed

Lines changed: 15 additions & 204 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ The Tvheadend project welcomes all submissions from the community. Without them
44

55
We want to ensure that the process of submitting code is as simple as possible whilst ensuring that the project has the necessary provisions to fully utilize and handle all submissions. Therefore some short guidelines are provided here for reference.
66

7-
For further info, please see https://tvheadend.org/projects/tvheadend/wiki/Contributors.
8-
97
## Before you start
108

119
* Make sure you have a [GitHub account](https://github.com/signup/free)
@@ -15,10 +13,9 @@ For further info, please see https://tvheadend.org/projects/tvheadend/wiki/Contr
1513
## Making Changes
1614

1715
* If unsure, discuss any potential work on IRC channel to avoid duplicate work.
18-
* Create a branch to put your changes. Use a sensible name, i.e. feature/whizzbanger, or bugfix/redmine-1234.
19-
* It's strongly recommend you create one branch per feature/bugfix/etc..
16+
* Create a branch to put your changes. Use a sensible name, i.e. feature/whizzbanger, or bugfix/issue-1234. It is strongly recommend you create one branch per feature/bugfix/etc.
2017
* Make commits, try and keep commits to sensible units.
21-
* Use sensible commit messages, prefix with subsystem, summary on first line, more detail on following lines and include reference to any related issue numbers in Redmine.
18+
* Use sensible commit messages, prefix with subsystem, summary on first line, more detail on following lines and include reference to any related issue numbers in Github or forum threads.
2219

2320
````
2421
mpegts dvb: Add foo feature to the DVB system.
@@ -31,7 +28,6 @@ This fixes #1234.
3128

3229
# Additional Resources
3330

34-
* [More information on contributing](https://tvheadend.org/projects/tvheadend/wiki/Contributors)
3531
* [Forum](https://tvheadend.org)
3632
* [General GitHub documentation](http://help.github.com/)
3733
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

‎LICENSE.md‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,3 @@ Code not Covered
1212
----------------
1313

1414
Code in the "vendor" directory is not covered by our license, it is 3rd party provided code and as such is governed by individual licenses.
15-
16-
Further Information
17-
-------------------
18-
19-
For more information regarding licensing and contributions, please see:
20-
21-
> https://tvheadend.org/projects/tvheadend/wiki/Contributors

‎README.md‎

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -86,13 +86,4 @@ Transcoding is currently not supported.
8686
Packages
8787
--------
8888

89-
Install instructions for various distributions can be found at our [Cloudsmith-Repository](https://cloudsmith.io/~tvheadend/repos/tvheadend/packages/).
90-
91-
Further information
92-
-------------------
93-
94-
For more information about building, including generating packages, please visit:
95-
* https://old.tvheadend.org/projects/tvheadend/wiki/Building
96-
* https://old.tvheadend.org/projects/tvheadend/wiki/Packaging
97-
* https://old.tvheadend.org/projects/tvheadend/wiki/Git
98-
* https://old.tvheadend.org/projects/tvheadend/wiki/Internationalization
89+
Install instructions for various distributions can be found in our [documentation](https://docs.tvheadend.org/documentation/installation/linux).

‎docs/markdown/doc_about.md‎

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,16 @@
22

33
This documentation forms part of the Tvheadend project.
44

5-
All rights reserved, and all implications of using, following, not
6-
following, or in any way even being aware of this documentation are
7-
expressly excluded. Use everything entirely at your own risk. If your
8-
television explodes, your house burns down or your kittens end up in
9-
tears, that's nothing to do with us.
10-
11-
(c) 2006 - 2017 Tvheadend Foundation CIC
5+
(c) 2006 - date Tvheadend contributors
126

137
## Licensing
148

159
The entire project is currently licensed using [GPLv3](http://www.gnu.org/licenses/gpl-3.0.txt).
1610

1711
## Further Information
1812

19-
For more information regarding the project, licensing and contributions, please see:
13+
For more information regarding the project, please see:
2014

2115
[Project website](https://tvheadend.org)
2216

23-
[Contributor information](https://tvheadend.org/projects/tvheadend/wiki/Contributors)
24-
25-
[Contributor Licensing Agreement](https://tvheadend.org/projects/tvheadend/wiki/CLA)
17+
[Project docmentation](https://docs.tvheadend.org/documentation)

‎docs/markdown/doc_update.md‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,10 @@ direct inclusion to tvheadend binary. The markdown processor in
55
Tvheadend binary adds other information from the internal
66
class system.
77

8-
The User Guide
9-
in [documentatation repository](https://github.com/tvheadend/tvheadend-documentation)
10-
fetches the markdown files using the build-in web server and use
11-
them as source for mkdocs.
12-
138
### Instructions For Built-in Help
149

1510
Change markdown files in `docs/markdown`, `docs/markdown/inc`, `docs/class`, `docs/wizard`, etc.
1611
Images are placed in `src/webui/static/img/doc/`.
1712

18-
Build Tvheadend as you normally would, see the [development page](https://tvheadend.org/projects/tvheadend/wiki/Development) for details.
13+
Build Tvheadend as you normally would, see the [README](README.md) for details.
1914

‎docs/markdown/firstconfig.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ text; if this happens, don't panic, as you can easily change it later.
2828

2929
If you cannot see your preferred language in the language list and would
3030
like to help translate Tvheadend see
31-
[here](https://tvheadend.org/projects/tvheadend/wiki/Internationalization).
31+
[here](https://docs.tvheadend.org/documentation/development/translations).
3232

3333
### 2. Access Control
3434

‎docs/markdown/installation.md‎

Lines changed: 1 addition & 157 deletions
Original file line numberDiff line numberDiff line change
@@ -1,159 +1,3 @@
11
# Installation
22

3-
Contents | Description
4-
---------------------------------------------------------|------------------------------------
5-
[Basic Requirements](#basic-requirements) | What's needed to run Tvheadend
6-
[Install Your Tuners](#install-your-tuners) | Installing and setting up your hardware
7-
[Install Tvheadend](#install-tvheadend) | Where to get Tvheadend and how-to install it
8-
9-
---
10-
11-
## Basic Requirements
12-
13-
### Physical Architecture
14-
15-
It's perfectly possible to install and run Tvheadend as a single-seat installation,
16-
with the software running on the same system as any client software (e.g. Kodi),
17-
with all files stored locally.
18-
19-
Alternatively, you can run Tvheadend on a server, perhaps on an always-on
20-
system that houses your media, perhaps on a dedicated low-power system - it's your choice.
21-
22-
Where you have aerial/coax connections might influence your choice - unless
23-
you use SAT>IP or have some other way to transport your TV signal over a LAN,
24-
your Tvheadend installation has to live where you can actually connect your
25-
tuners.
26-
27-
### System Requirements
28-
29-
Wherever you install it, Tvheadend primarily runs on **Linux** - pre-built
30-
binaries are available for most Debian-based distributions (Debian itself, Ubuntu,
31-
Mint...) and RPMs for Fedora, or you can build it yourself. It runs on both
32-
32- and 64-bit x86 and ARM processors, and so also can be built for Android
33-
(which uses the Linux kernel).
34-
35-
You will only need **c. 30MB disk space** for the application and associated
36-
files, and maybe anything up to **1GB** for your configuration - depending on
37-
how many tuners of what type you have, how many channels you receive, your
38-
choice of programme guide, and so on. You'll clearly need much more for
39-
your recordings, though: as a guide, an hour of SD MPEG-2 video will take
40-
about 1GB, while high bitrate HD H.264 will easily consume 5GB+ per hour.
41-
42-
Tvheadend is intended to be lightweight, so it will run on a NAS or similar
43-
**low-powered CPU**. Note that the exception here is transcoding: if you want
44-
to convert high-definition video in real time then you will need a powerful,
45-
multi-core system. It will happily run in less than **1GB of RAM**, and many
46-
people run it successfully on original Raspberry Pis with perhaps only 256MB
47-
of usable free memory. This does depend on what else you're using the computer
48-
for, though, as a GUI will drain your system as will any serious file serving.
49-
50-
And, of course, you'll need one or more **TV tuners** if you want to receive
51-
regular broadcast television - otherwise, you're limited to IP sources.
52-
53-
An **Internet connection** is recommended but not essential. You need to
54-
have an accurate clock for EPG timers to work, for example, but this can be
55-
synchronised from the broadcast signal if you're not in a position to use
56-
`ntp` or similar.
57-
58-
### How Lightweight?
59-
60-
How about light enough to run on a travel router? Take a look at this
61-
[example](https://tvheadend.org/boards/4/topics/16579) from one of our users...
62-
63-
---
64-
65-
## Install Your Tuners
66-
67-
This section will give you some basic ideas on how to get your tuner working
68-
with your operating system. However, it's clearly way beyond the scope of
69-
this guide to tell you everything: consult specialist forums, search around,
70-
and at least do some research to work out what's likely to work or not
71-
before you hand over any money.
72-
73-
There is a discussion about supported hardware on [the Tvheadend
74-
forums](https://tvheadend.org/boards/5/topics/5102).
75-
76-
### 1. Install the Tuner Hardware
77-
78-
This is obviously a core requirement that's outside of the scope of this guide.
79-
80-
You basically have the choice of:
81-
82-
* External USB tuners that plug in
83-
* Internal (e.g. PCI) tuners that go inside the computer chassis
84-
* External SAT>IP tuners that send MPEG-TS streams over a LAN connection
85-
* External HDHomeRun tuners that send MPEG-TS streams over a LAN connection
86-
87-
Follow the appropriate installation instructions and, if relevant, the
88-
setup instruction (e.g. for SAT>IP, which are effectively small, standalone
89-
computers).
90-
91-
#### A Note on USB Tuners
92-
93-
USB tuners are cheap, work well and are frequently well-matched to physically-smaller
94-
builds (e.g. HTPCs) which simply don't have the internal slots. However, please
95-
remember that many need external power, or need a powered hub to work properly.
96-
97-
In addition, even USB3 doesn't have the greatest practical bandwidth per bus. That
98-
means you're probably asking for problems if you have four DVB-S2 dongles on the same USB
99-
connection to the motherboard.
100-
101-
This is particularly true of systems such as the Raspberry Pi which share USB
102-
bandwidth with the Ethernet port. Don't be surprised if this kind of platform struggles
103-
and/or reports errors in a multi-tuner configuration, especially on
104-
high-bandwidth (e.g. HD) streams.
105-
106-
### 2. Install Firmware and/or Drivers
107-
108-
Similar to the above, Tvheadend can do nothing if your tuners aren't working
109-
properly. A good place to check how to set up your tuners is the
110-
[LinuxTV wiki device library](http://www.linuxtv.org/wiki/index.php/Hardware_Device_Information) -
111-
this will not only tell you what's supported under Linux, but also
112-
how to get it all working.
113-
114-
As a broad guide, though, you need two main components: a driver, and firmware.
115-
116-
The **driver** is the piece of software that, as far as the operating system is concerned,
117-
controls the tuner hardware.
118-
119-
Driver software typically comes either built-in to the operating system
120-
(a clue here is documentation that says *"supported since kernel 3.16"*, for example)
121-
or as an external program that needs to be compiled in (e.g. how you'd build TBS'
122-
or Digital Devices drivers, or perhaps where the driver is supported in a later version
123-
of LinuxTV V4L-DVB than has made it to your kernel - the giveaway here is
124-
*"compile and install the latest media_build"*).
125-
126-
Many tuners then also require **firmware** - normally, a binary file that's been
127-
extracted from the proprietary drivers used by Windows.
128-
129-
Many Linux distros include a package for the most common devices (e.g.
130-
*linux-firmwares* under Ubuntu or *firmware-linux-nonfree* under Debian).
131-
If this isn't sufficient, a good source of firmware files are the
132-
[OpenElec](https://github.com/OpenELEC/dvb-firmware) and [LibreELEC](https://github.com/libreELEC/dvb-firmware)
133-
firmware repositories on Github.
134-
135-
Typically, download the binary file and install it into `/lib/firmware`, owned
136-
by `root:root`, permissions `rw-r--r--` (0644)
137-
138-
---
139-
140-
## Install Tvheadend
141-
142-
This section tells you how to get hold of the software in the first place,
143-
and how to get it onto your system.
144-
145-
Follow the instructions that are specific to your Linux distribution
146-
(Ubuntu/Debian/Mint, Arch, Fedora...). This will typically be PPA-and-dpkg
147-
for Debian, but most other distros will need you to build your own version from source.
148-
149-
* [Debian/Ubuntu installation instructions](https://tvheadend.org/projects/tvheadend/wiki/AptRepository)
150-
151-
* [Instructions on how to build from source](https://tvheadend.org/projects/tvheadend/wiki/Building)
152-
153-
Do not assume that your distro's package manager will give you the latest
154-
version of Tvheadend - indeed, give you any version at all. Always check.
155-
156-
Where a pre-built package exists, this will usually get you the last official
157-
stable version. However, more advanced users may be interested in running
158-
a development version - either a nightly build or a self-compiled version.
159-
3+
For information on the requirements for Tvheadend and installation instructions for various platforms, please see [here](https://docs.tvheadend.org/documentation/installation).

‎docs/markdown/introduction.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ clients may also be available).
108108
### Internationalisation
109109
* All text is encoded in UTF-8 to provide full international support.
110110
* All major character encodings in DVB are supported (e.g. for localised EPG character sets).
111-
* [Web interface internationalization](https://tvheadend.org/projects/tvheadend/wiki/Internationalization)
111+
* [Web interface internationalization](https://docs.tvheadend.org/documentation/development/translations)
112112

113113
---
114114

@@ -448,11 +448,11 @@ check-box so that the changes are applied to all (selected) entries.
448448

449449
This guide is intended to give you a high-level overview of how to set
450450
up and use Tvheadend. It does not aim to provide a complete description
451-
of every step or answer every question: more details are available on the
452-
Tvheadend [wiki](https://tvheadend.org/projects/tvheadend/wiki).
451+
of every step or answer every question: more details are available in the
452+
Tvheadend [documentation](https://docs.tvheadend.org/documentation).
453453

454454
Tvheadend includes copies of many of these pages in the application, which
455455
is easier to find when you're wondering what to do next.
456456

457-
If you get really stuck, there's the [forum](https://tvheadend.org/projects/tvheadend/boards)
457+
If you get really stuck, there's the [forum](https://tvheadend.org/)
458458
and IRC (*#hts* on *Libera*). If you don't have a client installed you can use the [webchat](https://web.libera.chat/?nick=tvhhelp|?#hts).

‎src/webui/static/app/tvheadend.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -586,7 +586,7 @@ tvheadend.mdhelp = function(pagename) {
586586
msg = _('There\'s no documentation available, or there was a problem loading the page.\n\n') +
587587
_('**You\'ll also see this page if you try and view documentation (for a feature) not included with your version of Tvheadend.**\n\n\n\n') +
588588
_('Please take a look at the other Help pages (Table of Contents), if you still can\'t find what you\'re ') +
589-
_('looking for please see the [Wiki](http://tvheadend.org/projects/tvheadend/wiki) ') +
589+
_('looking for please see the [documentation](http://docs.tvheadend.org/documentation) ') +
590590
_('or join the [IRC channel on libera](https://web.libera.chat/?nick=tvhhelp|?#hts).');
591591

592592
// Fake the result.

‎support/changelog‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ echo >"${CHANGELOG}" "tvheadend (${VER}) ${DIST}; urgency=low"
2626
echo >>"${CHANGELOG}"
2727
[ ! -z "$HISTORY" ] && echo >>"${CHANGELOG}" "${HISTORY}\n"
2828
echo >>"${CHANGELOG}" " * The full changelog(s) can be found at "
29-
echo >>"${CHANGELOG}" " https://tvheadend.org/projects/tvheadend/wiki/Releases"
29+
echo >>"${CHANGELOG}" " https://docs.tvheadend.org/documentation/introduction/release-change-log"
3030
echo >>"${CHANGELOG}" " https://github.com/tvheadend/tvheadend"
3131
echo >>"${CHANGELOG}"
3232
echo >>"${CHANGELOG}" " -- ${DEBFULLNAME} <${DEBEMAIL}> ${NOW}"

0 commit comments

Comments
 (0)