From 53ed6d7d1e678d7486337ce67a2f17b30bac21ac Mon Sep 17 00:00:00 2001 From: nodiscc Date: Thu, 26 Jan 2017 18:52:54 +0100 Subject: Generate HTML documentation using MkDocs (WIP) MkDocs is a static site generator geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML file. * http://www.mkdocs.org/ * http://www.mkdocs.org/user-guide/configuration/ Ref. #312 * remove pandoc-generated HTML documentation * move markdown doc to doc/md/, * mkdocs.yml: * generate HTML doc in doc/html * add pages TOC/ordering * use index.md as index page * Makefile: remove execute permissions from generated files * Makefile: rewrite htmlpages GFM to markdown conversion using sed: awk expression aslo matched '][' which causes invalid output on complex links with images or code blocks * Add mkdocs.yml to .gitattributes, exclude this file from release archives * Makefile: rename: htmldoc -> doc_html target * run make doc: pull latest markdown documentation from wiki * run make htmlpages: update html documentation --- doc/Release-Shaarli.html | 224 ----------------------------------------------- 1 file changed, 224 deletions(-) delete mode 100644 doc/Release-Shaarli.html (limited to 'doc/Release-Shaarli.html') diff --git a/doc/Release-Shaarli.html b/doc/Release-Shaarli.html deleted file mode 100644 index fa690c7c..00000000 --- a/doc/Release-Shaarli.html +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - - Shaarli – Release Shaarli - - - - - - -
- -
-

Release Shaarli

-

See Git - Maintaining a project - Tagging your [](.html)
-releases.

-

Prerequisites

-

This guide assumes that you have:

- -

GitHub release draft and CHANGELOG.md

-

See http://keepachangelog.com/en/0.3.0/ for changelog formatting.

-

GitHub release draft

-

GitHub allows drafting the release note for the upcoming release, from the Releases page. This way, the release note can be drafted while contributions are merged to master.

-

CHANGELOG.md

-

This file should contain the same information as the release note draft for the upcoming version.

-

Update it to:

- -
$ cd /path/to/shaarli
-
-$ nano CHANGELOG.md
-
-[...][](.html)
-## vA.B.C - UNRELEASED
-TBA
-
-## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD[](.html)
-[...][](.html)
-

Increment the version code, create and push a signed tag

-

Bump Shaarli's version

-
$ cd /path/to/shaarli
-
-# create a new branch
-$ git fetch upstream
-$ git checkout upstream/master -b v0.5.0
-
-# bump the version number
-$ vim index.php shaarli_version.php
-
-# rebuild the documentation from the wiki
-$ make htmldoc
-
-# commit the changes
-$ git add index.php shaarli_version.php doc
-$ git commit -s -m "Bump version to v0.5.0"
-
-# push the commit on your GitHub fork
-$ git push origin v0.5.0
-

Create and merge a Pull Request

-

This one is pretty straightforward ;-)

-

Create and push a signed tag

-
# update your local copy
-$ git checkout master
-$ git fetch upstream
-$ git pull upstream master
-
-# create a signed tag
-$ git tag -s -m "Release v0.5.0" v0.5.0
-
-# push it to "upstream"
-$ git push --tags upstream
-

Verify a signed tag

-

v0.5.0 is the first GPG-signed tag pushed on the Community Shaarli.

-

Let's have a look at its signature!

-
$ cd /path/to/shaarli
-$ git fetch upstream
-
-# get the SHA1 reference of the tag
-$ git show-ref tags/v0.5.0
-f7762cf803f03f5caf4b8078359a63783d0090c1 refs/tags/v0.5.0
-
-# verify the tag signature information
-$ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1
-gpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F
-gpg: Good signature from "VirtualTam <virtualtam@flibidi.net>" [ultimate][](.html)
-

Publish the GitHub release

-

Update release badges

-

Update README.md so version badges display and point to the newly released Shaarli version(s).

-

Create a GitHub release from a Git tag

-

From the previously drafted release:

- -

Generate and upload all-in-one release archives

-

Users with a shared hosting may have:

- -

To ease Shaarli installations, it is possible to generate and upload additional release archives,
-that will contain Shaarli code plus all required third-party libraries:

-
$ make release_archive
-

This will create the following archives:

- -

The archives need to be manually uploaded on the previously created GitHub release.

- - -- cgit v1.2.3