diff options
author | VirtualTam <virtualtam@flibidi.net> | 2017-08-05 11:56:24 +0200 |
---|---|---|
committer | VirtualTam <virtualtam@flibidi.net> | 2017-08-05 11:56:24 +0200 |
commit | 43ad7c8e825057747ccf02049050b323878952a7 (patch) | |
tree | 3160fd640c42f41a38d6c1df2cd4e020f87942ae /doc/md/Upgrade-and-migration.md | |
parent | b4ff0afb24db6e4cb3543bbd71f01bbb0716b144 (diff) | |
download | Shaarli-43ad7c8e825057747ccf02049050b323878952a7.tar.gz Shaarli-43ad7c8e825057747ccf02049050b323878952a7.tar.zst Shaarli-43ad7c8e825057747ccf02049050b323878952a7.zip |
documentation: fix rendering and internal references
This is mainly cleanup after switching from Github-flavoured Markdown
rendered by Github Pages, to standard Markdown rendered by MkDocs.
Changed:
- rephrase some section titles
Fixed:
- list rendering (items, sub-items))
- code rendering
- quotes
- dead links
Removed:
- extraneous navigational elements
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
Diffstat (limited to 'doc/md/Upgrade-and-migration.md')
-rw-r--r-- | doc/md/Upgrade-and-migration.md | 17 |
1 files changed, 10 insertions, 7 deletions
diff --git a/doc/md/Upgrade-and-migration.md b/doc/md/Upgrade-and-migration.md index 2002a4e2..b3a08764 100644 --- a/doc/md/Upgrade-and-migration.md +++ b/doc/md/Upgrade-and-migration.md | |||
@@ -8,6 +8,7 @@ The current version is present in the `version.php` file. | |||
8 | ### Backup your data | 8 | ### Backup your data |
9 | 9 | ||
10 | Shaarli stores all user data under the `data` directory: | 10 | Shaarli stores all user data under the `data` directory: |
11 | |||
11 | - `data/config.php` - main configuration file | 12 | - `data/config.php` - main configuration file |
12 | - `data/datastore.php` - bookmarked links | 13 | - `data/datastore.php` - bookmarked links |
13 | - `data/ipbans.php` - banned IP addresses | 14 | - `data/ipbans.php` - banned IP addresses |
@@ -16,6 +17,7 @@ Shaarli stores all user data under the `data` directory: | |||
16 | See [Shaarli configuration](Shaarli configuration) for more information about Shaarli resources. | 17 | See [Shaarli configuration](Shaarli configuration) for more information about Shaarli resources. |
17 | 18 | ||
18 | It is recommended to backup this repository _before_ starting updating/upgrading Shaarli: | 19 | It is recommended to backup this repository _before_ starting updating/upgrading Shaarli: |
20 | |||
19 | - users with SSH access: copy or archive the directory to a temporary location | 21 | - users with SSH access: copy or archive the directory to a temporary location |
20 | - users with FTP access: download a local copy of your Shaarli installation using your favourite client | 22 | - users with FTP access: download a local copy of your Shaarli installation using your favourite client |
21 | 23 | ||
@@ -75,6 +77,7 @@ Updating dependencies | |||
75 | If you have installed Shaarli from [Sebsauvage's original Git repository](https://github.com/sebsauvage/Shaarli), you can use [Git remotes](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) to update your working copy. | 77 | If you have installed Shaarli from [Sebsauvage's original Git repository](https://github.com/sebsauvage/Shaarli), you can use [Git remotes](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) to update your working copy. |
76 | 78 | ||
77 | The following guide assumes that: | 79 | The following guide assumes that: |
80 | |||
78 | - you have a basic knowledge of Git [branching](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell) and [remote repositories](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) | 81 | - you have a basic knowledge of Git [branching](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell) and [remote repositories](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) |
79 | - the default remote is named `origin` and points to Sebsauvage's repository | 82 | - the default remote is named `origin` and points to Sebsauvage's repository |
80 | - the current branch is `master` | 83 | - the current branch is `master` |
@@ -174,7 +177,7 @@ After migrating, access your fresh Shaarli installation from a web browser; the | |||
174 | 177 | ||
175 | ## Troubleshooting | 178 | ## Troubleshooting |
176 | 179 | ||
177 | If the solutions provided here doesn't work, please open an issue specifying which version you're upgrading from and to. | 180 | If the solutions provided here don't work, please open an issue specifying which version you're upgrading from and to. |
178 | 181 | ||
179 | ### You must specify an integer as a key | 182 | ### You must specify an integer as a key |
180 | 183 | ||
@@ -185,10 +188,10 @@ Take a look at `data/updates.txt` content. | |||
185 | 188 | ||
186 | Try to delete it and refresh your page while being logged in. | 189 | Try to delete it and refresh your page while being logged in. |
187 | 190 | ||
188 | #### `updates.txt` doesn't exists or doesn't contain `updateMethodDatastoreIds` | 191 | #### `updates.txt` doesn't exist or doesn't contain `updateMethodDatastoreIds` |
189 | 192 | ||
190 | 1. Create `data/updates.txt` if it doesn't exist. | 193 | 1. Create `data/updates.txt` if it doesn't exist |
191 | 2. Paste this string in the update file `;updateMethodRenameDashTags;` | 194 | 2. Paste this string in the update file `;updateMethodRenameDashTags;` |
192 | 3. Login to Shaarli. | 195 | 3. Login to Shaarli |
193 | 4. Delete the update file. | 196 | 4. Delete the update file |
194 | 5. Refresh. | 197 | 5. Refresh |