aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md/Release-Shaarli.md
diff options
context:
space:
mode:
authorVirtualTam <virtualtam@flibidi.net>2017-08-05 11:56:24 +0200
committerVirtualTam <virtualtam@flibidi.net>2017-08-05 11:56:24 +0200
commit43ad7c8e825057747ccf02049050b323878952a7 (patch)
tree3160fd640c42f41a38d6c1df2cd4e020f87942ae /doc/md/Release-Shaarli.md
parentb4ff0afb24db6e4cb3543bbd71f01bbb0716b144 (diff)
downloadShaarli-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/Release-Shaarli.md')
-rw-r--r--doc/md/Release-Shaarli.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/md/Release-Shaarli.md b/doc/md/Release-Shaarli.md
index 0e445272..bb2b3b5c 100644
--- a/doc/md/Release-Shaarli.md
+++ b/doc/md/Release-Shaarli.md
@@ -3,6 +3,7 @@ releases](http://git-scm.com/book/en/v2/Distributed-Git-Maintaining-a-Project#Ta
3 3
4## Prerequisites 4## Prerequisites
5This guide assumes that you have: 5This guide assumes that you have:
6
6- a GPG key matching your GitHub authentication credentials 7- a GPG key matching your GitHub authentication credentials
7 - i.e., the email address identified by the GPG key is the same as the one in your `~/.gitconfig` 8 - i.e., the email address identified by the GPG key is the same as the one in your `~/.gitconfig`
8- a GitHub fork of Shaarli 9- a GitHub fork of Shaarli
@@ -43,7 +44,7 @@ TBA
43``` 44```
44 45
45 46
46## Increment the version code, updated docs, create and push a signed tag 47## Increment the version code, update docs, create and push a signed tag
47### Generate documentation 48### Generate documentation
48```bash 49```bash
49$ cd /path/to/shaarli 50$ cd /path/to/shaarli
@@ -125,6 +126,7 @@ Update `README.md` so version badges display and point to the newly released Sha
125 126
126### Create a GitHub release from a Git tag 127### Create a GitHub release from a Git tag
127From the previously drafted release: 128From the previously drafted release:
129
128- edit the release notes (if needed) 130- edit the release notes (if needed)
129- specify the appropriate Git tag 131- specify the appropriate Git tag
130- publish the release 132- publish the release
@@ -132,6 +134,7 @@ From the previously drafted release:
132 134
133### Generate and upload all-in-one release archives 135### Generate and upload all-in-one release archives
134Users with a shared hosting may have: 136Users with a shared hosting may have:
137
135- no SSH access 138- no SSH access
136- no possibility to install PHP packages or server extensions 139- no possibility to install PHP packages or server extensions
137- no possibility to run scripts 140- no possibility to run scripts
@@ -146,6 +149,7 @@ $ make release_archive
146``` 149```
147 150
148This will create the following archives: 151This will create the following archives:
152
149- `shaarli-vX.Y.Z-full.tar` 153- `shaarli-vX.Y.Z-full.tar`
150- `shaarli-vX.Y.Z-full.zip` 154- `shaarli-vX.Y.Z-full.zip`
151 155