diff options
author | Willi Eggeling <mail@wje-online.de> | 2017-08-26 09:40:57 +0200 |
---|---|---|
committer | Willi Eggeling <mail@wje-online.de> | 2017-08-26 09:40:57 +0200 |
commit | cc8f572bc063aa1e9d0368c8a8361f15efe04c9b (patch) | |
tree | 1d6fe87627da391bd99ddf346f20ae1d66930bc5 | |
parent | de901736a663934c1b67f09f1d586da665f0f036 (diff) | |
download | Shaarli-cc8f572bc063aa1e9d0368c8a8361f15efe04c9b.tar.gz Shaarli-cc8f572bc063aa1e9d0368c8a8361f15efe04c9b.tar.zst Shaarli-cc8f572bc063aa1e9d0368c8a8361f15efe04c9b.zip |
migrated Github wiki links to readthedocs
-rw-r--r-- | CHANGELOG.md | 2 | ||||
-rw-r--r-- | CONTRIBUTING.md | 2 | ||||
-rw-r--r-- | application/LinkDB.php | 2 | ||||
-rw-r--r-- | application/config/ConfigManager.php | 4 | ||||
-rw-r--r-- | composer.json | 2 | ||||
-rw-r--r-- | doc/md/Plugin-System.md | 4 | ||||
-rw-r--r-- | doc/md/Plugins.md | 2 | ||||
-rw-r--r-- | doc/md/index.md | 2 | ||||
-rw-r--r-- | index.php | 6 | ||||
-rw-r--r-- | plugins/playvideos/README.md | 2 |
10 files changed, 14 insertions, 14 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 4b018cb4..60262d56 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md | |||
@@ -61,7 +61,7 @@ The documentation has been migrated to ReadTheDocs: | |||
61 | This release introduces the REST API, and requires updating HTTP server | 61 | This release introduces the REST API, and requires updating HTTP server |
62 | configuration to enable URL rewriting, see: | 62 | configuration to enable URL rewriting, see: |
63 | - https://shaarli.github.io/api-documentation/ | 63 | - https://shaarli.github.io/api-documentation/ |
64 | - https://github.com/shaarli/Shaarli/wiki/Server-configuration | 64 | - https://shaarli.readthedocs.io/en/master/Server-configuration/ |
65 | 65 | ||
66 | **WARNING**: Shaarli now requires PHP 5.5+. | 66 | **WARNING**: Shaarli now requires PHP 5.5+. |
67 | 67 | ||
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bb82951d..03564fd2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md | |||
@@ -54,7 +54,7 @@ Please report any problem you might find. | |||
54 | * starting from branch ` master`, switch to a new branch (eg. `git checkout -b my-awesome-feature`) | 54 | * starting from branch ` master`, switch to a new branch (eg. `git checkout -b my-awesome-feature`) |
55 | * edit the required files (from the Github web interface or your text editor) | 55 | * edit the required files (from the Github web interface or your text editor) |
56 | * add and commit your changes with a meaningful commit message (eg `Cool new feature, fixes issue #1001`) | 56 | * add and commit your changes with a meaningful commit message (eg `Cool new feature, fixes issue #1001`) |
57 | * run unit tests against your patched version, see [Running unit tests](https://github.com/shaarli/Shaarli/wiki/Running-unit-tests) | 57 | * run unit tests against your patched version, see [Running unit tests](https://shaarli.readthedocs.io/en/master/Unit-tests/#run-unit-tests) |
58 | * Open your fork in the Github web interface and click the "Compare and Pull Request" button, enter required info and submit your Pull Request. | 58 | * Open your fork in the Github web interface and click the "Compare and Pull Request" button, enter required info and submit your Pull Request. |
59 | 59 | ||
60 | All changes you will do on the `my-awesome-feature` in the future will be added to your Pull Request. Don't work directly on the master branch, don't do unrelated work on your `my-awesome-feature` branch. | 60 | All changes you will do on the `my-awesome-feature` in the future will be added to your Pull Request. Don't work directly on the master branch, don't do unrelated work on your `my-awesome-feature` branch. |
diff --git a/application/LinkDB.php b/application/LinkDB.php index 9308164a..22c1f0ab 100644 --- a/application/LinkDB.php +++ b/application/LinkDB.php | |||
@@ -249,7 +249,7 @@ class LinkDB implements Iterator, Countable, ArrayAccess | |||
249 | $link = array( | 249 | $link = array( |
250 | 'id' => 1, | 250 | 'id' => 1, |
251 | 'title'=>' Shaarli: the personal, minimalist, super-fast, no-database delicious clone', | 251 | 'title'=>' Shaarli: the personal, minimalist, super-fast, no-database delicious clone', |
252 | 'url'=>'https://github.com/shaarli/Shaarli/wiki', | 252 | 'url'=>'https://shaarli.readthedocs.io', |
253 | 'description'=>'Welcome to Shaarli! This is your first public bookmark. To edit or delete me, you must first login. | 253 | 'description'=>'Welcome to Shaarli! This is your first public bookmark. To edit or delete me, you must first login. |
254 | 254 | ||
255 | To learn how to use Shaarli, consult the link "Help/documentation" at the bottom of this page. | 255 | To learn how to use Shaarli, consult the link "Help/documentation" at the bottom of this page. |
diff --git a/application/config/ConfigManager.php b/application/config/ConfigManager.php index 8eab26f1..0fc5a5c7 100644 --- a/application/config/ConfigManager.php +++ b/application/config/ConfigManager.php | |||
@@ -9,8 +9,8 @@ use Shaarli\Config\Exception\UnauthorizedConfigException; | |||
9 | * | 9 | * |
10 | * Manages all Shaarli's settings. | 10 | * Manages all Shaarli's settings. |
11 | * See the documentation for more information on settings: | 11 | * See the documentation for more information on settings: |
12 | * - doc/Shaarli-configuration.html | 12 | * - doc/md/Shaarli-configuration.md |
13 | * - https://github.com/shaarli/Shaarli/wiki/Shaarli-configuration | 13 | * - https://shaarli.readthedocs.io/en/master/Shaarli-configuration/#configuration |
14 | */ | 14 | */ |
15 | class ConfigManager | 15 | class ConfigManager |
16 | { | 16 | { |
diff --git a/composer.json b/composer.json index 756ea588..afb8aca4 100644 --- a/composer.json +++ b/composer.json | |||
@@ -6,7 +6,7 @@ | |||
6 | "homepage": "https://github.com/shaarli/Shaarli", | 6 | "homepage": "https://github.com/shaarli/Shaarli", |
7 | "support": { | 7 | "support": { |
8 | "issues": "https://github.com/shaarli/Shaarli/issues", | 8 | "issues": "https://github.com/shaarli/Shaarli/issues", |
9 | "wiki": "https://github.com/shaarli/Shaarli/wiki" | 9 | "wiki": "https://shaarli.readthedocs.io" |
10 | }, | 10 | }, |
11 | "keywords": ["bookmark", "link", "share", "web"], | 11 | "keywords": ["bookmark", "link", "share", "web"], |
12 | "config": { | 12 | "config": { |
diff --git a/doc/md/Plugin-System.md b/doc/md/Plugin-System.md index 30f0ae74..cbec04c0 100644 --- a/doc/md/Plugin-System.md +++ b/doc/md/Plugin-System.md | |||
@@ -49,10 +49,10 @@ hook_<plugin_name>_<hook_name>($data, $conf) | |||
49 | 49 | ||
50 | Parameters: | 50 | Parameters: |
51 | 51 | ||
52 | - data: see [$data section](https://github.com/shaarli/Shaarli/wiki/Plugin-System#plugins-data) | 52 | - data: see [$data section](https://shaarli.readthedocs.io/en/master/Plugin-System/#plugins-data) |
53 | - conf: the `ConfigManager` instance. | 53 | - conf: the `ConfigManager` instance. |
54 | 54 | ||
55 | For exemple, if my plugin want to add data to the header, this function is needed: | 55 | For example, if my plugin want to add data to the header, this function is needed: |
56 | 56 | ||
57 | hook_demo_plugin_render_header | 57 | hook_demo_plugin_render_header |
58 | 58 | ||
diff --git a/doc/md/Plugins.md b/doc/md/Plugins.md index 7d40637f..463dae17 100644 --- a/doc/md/Plugins.md +++ b/doc/md/Plugins.md | |||
@@ -72,4 +72,4 @@ Usage of each plugin is documented in it's README file: | |||
72 | 72 | ||
73 | #### Third party plugins | 73 | #### Third party plugins |
74 | 74 | ||
75 | See [Community & related software](https://github.com/shaarli/Shaarli/wiki/Community-%26-Related-software#third-party-plugins) | 75 | See [Community & related software](https://shaarli.readthedocs.io/en/master/Community-&-Related-software/) |
diff --git a/doc/md/index.md b/doc/md/index.md index b10e3cf4..24ada6c7 100644 --- a/doc/md/index.md +++ b/doc/md/index.md | |||
@@ -37,7 +37,7 @@ Login: `demo`; Password: `demo` | |||
37 | - daily RSS feed | 37 | - daily RSS feed |
38 | - permalinks for easy reference | 38 | - permalinks for easy reference |
39 | - links can be public or private | 39 | - links can be public or private |
40 | - extensible through [plugins](https://github.com/shaarli/Shaarli/wiki/Plugins#plugin-usage) | 40 | - extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage) |
41 | 41 | ||
42 | ### Tag, view and search your links! | 42 | ### Tag, view and search your links! |
43 | - add a custom title and description to archived links | 43 | - add a custom title and description to archived links |
@@ -48,8 +48,8 @@ if (! file_exists(__DIR__ . '/vendor/autoload.php')) { | |||
48 | ."If you installed Shaarli through Git or using the development branch,\n" | 48 | ."If you installed Shaarli through Git or using the development branch,\n" |
49 | ."please refer to the installation documentation to install PHP" | 49 | ."please refer to the installation documentation to install PHP" |
50 | ." dependencies using Composer:\n" | 50 | ." dependencies using Composer:\n" |
51 | ."- https://github.com/shaarli/Shaarli/wiki/Server-requirements\n" | 51 | ."- https://shaarli.readthedocs.io/en/master/Server-requirements/\n" |
52 | ."- https://github.com/shaarli/Shaarli/wiki/Download-and-Installation"; | 52 | ."- https://shaarli.readthedocs.io/en/master/Download-and-Installation/"; |
53 | exit; | 53 | exit; |
54 | } | 54 | } |
55 | require_once 'inc/rain.tpl.class.php'; | 55 | require_once 'inc/rain.tpl.class.php'; |
@@ -1233,7 +1233,7 @@ function renderPage($conf, $pluginManager, $LINKSDB, $history) | |||
1233 | // Linkdate is kept here to: | 1233 | // Linkdate is kept here to: |
1234 | // - use the same permalink for notes as they're displayed when creating them | 1234 | // - use the same permalink for notes as they're displayed when creating them |
1235 | // - let users hack creation date of their posts | 1235 | // - let users hack creation date of their posts |
1236 | // See: https://github.com/shaarli/Shaarli/wiki/Datastore-hacks#changing-the-timestamp-for-a-link | 1236 | // See: https://shaarli.readthedocs.io/en/master/Various-hacks/#changing-the-timestamp-for-a-shaare |
1237 | $linkdate = escape($_POST['lf_linkdate']); | 1237 | $linkdate = escape($_POST['lf_linkdate']); |
1238 | if (isset($LINKSDB[$id])) { | 1238 | if (isset($LINKSDB[$id])) { |
1239 | // Edit | 1239 | // Edit |
diff --git a/plugins/playvideos/README.md b/plugins/playvideos/README.md index b1698470..ab4be22a 100644 --- a/plugins/playvideos/README.md +++ b/plugins/playvideos/README.md | |||
@@ -8,7 +8,7 @@ This uses code from https://zaius.github.io/youtube_playlist/ and is currently o | |||
8 | 8 | ||
9 | #### Installation and setup | 9 | #### Installation and setup |
10 | 10 | ||
11 | This is a default Shaarli plugin, you just have to enable it. See https://github.com/shaarli/Shaarli/wiki/Shaarli-configuration/ | 11 | This is a default Shaarli plugin, you just have to enable it. See https://shaarli.readthedocs.io/en/master/Shaarli-configuration/ |
12 | 12 | ||
13 | 13 | ||
14 | #### Troubleshooting | 14 | #### Troubleshooting |