Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

make htmlpages

Browse source
This commit is contained in:
nodiscc 2017-07-04 21:30:31 +02:00
parent f47aa40c12
commit 366247c84c
4 changed files with 236 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/html/Release-Shaarli/index.html
View file

@ -337,7 +337,8 @@ <h2 id="prerequisites">Prerequisites</h2>
- maintainer permissions on the main Shaarli repository, to:
- push the signed tag
- create a new release
- <a href="https://getcomposer.org/">Composer</a> and <a href="http://pandoc.org/">Pandoc</a> need to be installed</p>
- <a href="https://getcomposer.org/">Composer</a> needs to be installed
- The <a href="https://docs.python.org/3/library/venv.html">venv</a> Python 3 module needs to be installed for HTML documentation generation.</p>
<h2 id="github-release-draft-and-changelogmd">GitHub release draft and <code>CHANGELOG.md</code></h2>
<p>See http://keepachangelog.com/en/0.3.0/ for changelog formatting.</p>
<h3 id="github-release-draft">GitHub release draft</h3>
@ -368,8 +369,8 @@ <h3 id="generate-documentation">Generate documentation</h3>
$ git fetch upstream
$ git checkout upstream/master -b v0.5.0
# rebuild the documentation from the wiki
$ make htmldoc
# rebuild the HTML documentation from Markdown
$ make htmlpages
# commit the changes
$ git add doc

121
doc/html/index.html
View file

@ -53,6 +53,19 @@
<a class="current" href=".">Home</a>
<ul class="subnav">
<li class="toctree-l2"><a href="#shaarli-documentation">Shaarli documentation</a></li>
<ul>
<li><a class="toctree-l3" href="#demo">Demo</a></li>
<li><a class="toctree-l3" href="#features">Features</a></li>
<li><a class="toctree-l3" href="#about">About</a></li>
</ul>
</ul>
</li>
@ -274,12 +287,112 @@
<div role="main">
<div class="section">
<p>Welcome to the <a href="https://github.com/shaarli/Shaarli/">Shaarli</a> wiki!</p>
<h1 id="shaarli-documentation"><a href="https://github.com/shaarli/Shaarli/">Shaarli</a> documentation</h1>
<p>Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.</p>
<p>For general info, read the <a href="https://github.com/shaarli/Shaarli/blob/master/README.md">README</a>.</p>
<p>If you have any questions or ideas, please join the <a href="https://gitter.im/shaarli/Shaarli">chat</a> (also reachable via <a href="https://irc.gitter.im/">IRC</a>), post them in our <a href="https://github.com/shaarli/Shaarli/issues/308">general discussion</a> (<a href="https://github.com/shaarli/Shaarli/issues/44">archive</a>) or read the current <a href="https://github.com/shaarli/Shaarli/issues">issues</a>. If you've found a bug, please create a <a href="https://github.com/shaarli/Shaarli/issues/new">new issue</a>.</p>
<p>If you have any questions or ideas, please join the <a href="https://gitter.im/shaarli/Shaarli">chat</a> (also reachable via <a href="https://irc.gitter.im/">IRC</a>), post them in our <a href="https://github.com/shaarli/Shaarli/issues/308">general discussion</a> or read the current <a href="https://github.com/shaarli/Shaarli/issues">issues</a>.
If you've found a bug, please create a <a href="https://github.com/shaarli/Shaarli/issues/new">new issue</a>.</p>
<p>If you would like a feature added to Shaarli, check the issues labeled <a href="https://github.com/shaarli/Shaarli/labels/feature"><code>feature</code></a>, <a href="https://github.com/shaarli/Shaarli/labels/enhancement"><code>enhancement</code></a>, and <a href="https://github.com/shaarli/Shaarli/labels/plugin"><code>plugin</code></a>.</p>
<p><em>Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the <code>doc/</code> directory of your Shaarli installation.</em></p>
<p><em>Note: This documentation is available online at https://shaarli.readthedocs.io/, and locally in the <code>doc/html/</code> directory of your Shaarli installation.</em></p>
<p><a href="https://gitter.im/shaarli/Shaarli"><img alt="Join the chat at https://gitter.im/shaarli/Shaarli" src="https://badges.gitter.im/Join%20Chat.svg" /></a>
<a href="https://www.bountysource.com/teams/shaarli/issues"><img alt="Bountysource" src="https://www.bountysource.com/badge/team?team_id=19583&amp;style=bounties_received" /></a>
<a href="https://hub.docker.com/r/shaarli/shaarli/"><img alt="Docker repository" src="https://img.shields.io/docker/pulls/shaarli/shaarli.svg" /></a></p>
<h3 id="demo">Demo</h3>
<p>You can use this <a href="https://demo.shaarli.org">public demo instance of Shaarli</a>.
It runs the latest development version of Shaarli and is updated/reset daily.</p>
<p>Login: <code>demo</code>; Password: <code>demo</code></p>
<h2 id="features">Features</h2>
<h3 id="interface">Interface</h3>
<ul>
<li>minimalist design (simple is beautiful)</li>
<li>FAST</li>
<li>ATOM and RSS feeds</li>
<li>views:<ul>
<li>paginated link list</li>
<li>tag cloud</li>
<li>picture wall: image and video thumbnails</li>
<li>daily: newspaper-like daily digest</li>
<li>daily RSS feed</li>
</ul>
</li>
<li>permalinks for easy reference</li>
<li>links can be public or private</li>
<li>extensible through <a href="https://github.com/shaarli/Shaarli/wiki/Plugins#plugin-usage">plugins</a></li>
</ul>
<h3 id="tag-view-and-search-your-links">Tag, view and search your links!</h3>
<ul>
<li>add a custom title and description to archived links</li>
<li>add tags to classify and search links<ul>
<li>features tag autocompletion, renaming, merging and deletion</li>
</ul>
</li>
<li>full-text and tag search</li>
</ul>
<h3 id="easy-setup">Easy setup</h3>
<ul>
<li>dead-simple installation: drop the files, open the page</li>
<li>links are stored in a file<ul>
<li>compact storage</li>
<li>no database required</li>
<li>easy backup: simply copy the datastore file</li>
</ul>
</li>
<li>import and export links as Netscape bookmarks</li>
</ul>
<h3 id="accessibility">Accessibility</h3>
<ul>
<li>Firefox bookmarlet to share links in one click</li>
<li>support for mobile browsers</li>
<li>works with Javascript disabled</li>
<li>easy page customization through HTML/CSS/RainTPL</li>
</ul>
<h3 id="security">Security</h3>
<ul>
<li>bruteforce-proof login form</li>
<li>protected against <a href="http://en.wikipedia.org/wiki/Cross-site_request_forgery">XSRF</a>
and session cookie hijacking</li>
</ul>
<h3 id="goodies">Goodies</h3>
<ul>
<li>thumbnail generation for images and video services:
dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube...<ul>
<li>lazy-loading with <a href="http://dinbror.dk/blazy/">bLazy</a></li>
</ul>
</li>
<li><a href="https://code.google.com/p/pubsubhubbub/">PubSubHubbub</a> protocol support</li>
<li>URL cleanup: automatic removal of <code>?utm_source=...</code>, <code>fb=...</code></li>
<li>discreet pop-up notification when a new release is available</li>
</ul>
<h3 id="rest-api">REST API</h3>
<p>Easily extensible by any client using the REST API exposed by Shaarli.</p>
<p>See the <a href="http://shaarli.github.io/api-documentation/">API documentation</a>.</p>
<h3 id="other-usages">Other usages</h3>
<p>Though Shaarli is primarily a bookmarking application, it can serve other purposes
(see <a href="https://github.com/shaarli/Shaarli/wiki#usage-examples">usage examples</a>):
- micro-blogging
- pastebin
- online notepad
- snippet archive</p>
<h2 id="about">About</h2>
<h3 id="shaarli-community-fork">Shaarli community fork</h3>
<p>This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli</p>
<p>This is a community fork of the original <a href="https://github.com/sebsauvage/Shaarli/">Shaarli</a> project by <a href="http://sebsauvage.net/">Sébastien Sauvage</a>.</p>
<p>The original project is currently unmaintained, and the developer <a href="https://github.com/sebsauvage/Shaarli/issues/191">has informed us</a>
that he would have no time to work on Shaarli in the near future.
The Shaarli community has carried on the work to provide
<a href="https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master">many patches</a>
for <a href="https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+">bug fixes and enhancements</a>
in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient.</p>
<h3 id="contributing">Contributing</h3>
<p>If you'd like to help, please:
- have a look at the open <a href="https://github.com/shaarli/Shaarli/issues">issues</a>
and <a href="https://github.com/shaarli/Shaarli/pulls">pull requests</a>
- feel free to report bugs (feedback is much appreciated)
- suggest new features and improvements to both code and <a href="https://github.com/shaarli/Shaarli/wiki">documentation</a>
- propose solutions to existing problems
- submit pull requests :-)</p>
<h3 id="license">License</h3>
<p>Shaarli is <a href="http://en.wikipedia.org/wiki/Free_software">Free Software</a>. See <a href="./COPYING">COPYING</a> for a detail of the contributors and licenses for each individual component.</p>
</div>
</div>
@ -328,5 +441,5 @@
<!--
MkDocs version : 0.16.3
Build Date UTC : 2017-06-18 04:31:25
Build Date UTC : 2017-07-04 19:29:47
-->

83
doc/html/mkdocs/search_index.json
View file

@ -2,9 +2,84 @@
"docs": [
{
"location": "/",
"text": "Welcome to the \nShaarli\n wiki!\n\n\nHere you can find some info on how to use, configure, tweak and solve problems with your Shaarli.\n\n\nFor general info, read the \nREADME\n.\n\n\nIf you have any questions or ideas, please join the \nchat\n (also reachable via \nIRC\n), post them in our \ngeneral discussion\n (\narchive\n) or read the current \nissues\n. If you've found a bug, please create a \nnew issue\n.\n\n\nIf you would like a feature added to Shaarli, check the issues labeled \nfeature\n, \nenhancement\n, and \nplugin\n.\n\n\nNote: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the \ndoc/\n directory of your Shaarli installation.",
"text": "Shaarli\n documentation\n\n\nHere you can find some info on how to use, configure, tweak and solve problems with your Shaarli.\n\n\nFor general info, read the \nREADME\n.\n\n\nIf you have any questions or ideas, please join the \nchat\n (also reachable via \nIRC\n), post them in our \ngeneral discussion\n or read the current \nissues\n.\nIf you've found a bug, please create a \nnew issue\n.\n\n\nIf you would like a feature added to Shaarli, check the issues labeled \nfeature\n, \nenhancement\n, and \nplugin\n.\n\n\nNote: This documentation is available online at https://shaarli.readthedocs.io/, and locally in the \ndoc/html/\n directory of your Shaarli installation.\n\n\n\n\n\n\n\n\nDemo\n\n\nYou can use this \npublic demo instance of Shaarli\n.\nIt runs the latest development version of Shaarli and is updated/reset daily.\n\n\nLogin: \ndemo\n; Password: \ndemo\n\n\nFeatures\n\n\nInterface\n\n\n\n\nminimalist design (simple is beautiful)\n\n\nFAST\n\n\nATOM and RSS feeds\n\n\nviews:\n\n\npaginated link list\n\n\ntag cloud\n\n\npicture wall: image and video thumbnails\n\n\ndaily: newspaper-like daily digest\n\n\ndaily RSS feed\n\n\n\n\n\n\npermalinks for easy reference\n\n\nlinks can be public or private\n\n\nextensible through \nplugins\n\n\n\n\nTag, view and search your links!\n\n\n\n\nadd a custom title and description to archived links\n\n\nadd tags to classify and search links\n\n\nfeatures tag autocompletion, renaming, merging and deletion\n\n\n\n\n\n\nfull-text and tag search\n\n\n\n\nEasy setup\n\n\n\n\ndead-simple installation: drop the files, open the page\n\n\nlinks are stored in a file\n\n\ncompact storage\n\n\nno database required\n\n\neasy backup: simply copy the datastore file\n\n\n\n\n\n\nimport and export links as Netscape bookmarks\n\n\n\n\nAccessibility\n\n\n\n\nFirefox bookmarlet to share links in one click\n\n\nsupport for mobile browsers\n\n\nworks with Javascript disabled\n\n\neasy page customization through HTML/CSS/RainTPL\n\n\n\n\nSecurity\n\n\n\n\nbruteforce-proof login form\n\n\nprotected against \nXSRF\n\nand session cookie hijacking\n\n\n\n\nGoodies\n\n\n\n\nthumbnail generation for images and video services:\ndailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube...\n\n\nlazy-loading with \nbLazy\n\n\n\n\n\n\nPubSubHubbub\n protocol support\n\n\nURL cleanup: automatic removal of \n?utm_source=...\n, \nfb=...\n\n\ndiscreet pop-up notification when a new release is available\n\n\n\n\nREST API\n\n\nEasily extensible by any client using the REST API exposed by Shaarli.\n\n\nSee the \nAPI documentation\n.\n\n\nOther usages\n\n\nThough Shaarli is primarily a bookmarking application, it can serve other purposes\n(see \nusage examples\n):\n- micro-blogging\n- pastebin\n- online notepad\n- snippet archive\n\n\nAbout\n\n\nShaarli community fork\n\n\nThis friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli\n\n\nThis is a community fork of the original \nShaarli\n project by \nS\u00e9bastien Sauvage\n.\n\n\nThe original project is currently unmaintained, and the developer \nhas informed us\n\nthat he would have no time to work on Shaarli in the near future.\nThe Shaarli community has carried on the work to provide\n\nmany patches\n\nfor \nbug fixes and enhancements\n\nin this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient.\n\n\nContributing\n\n\nIf you'd like to help, please:\n- have a look at the open \nissues\n\nand \npull requests\n\n- feel free to report bugs (feedback is much appreciated)\n- suggest new features and improvements to both code and \ndocumentation\n\n- propose solutions to existing problems\n- submit pull requests :-)\n\n\nLicense\n\n\nShaarli is \nFree Software\n. See \nCOPYING\n for a detail of the contributors and licenses for each individual component.",
"title": "Home"
},
{
"location": "/#shaarli-documentation",
"text": "Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli. For general info, read the README . If you have any questions or ideas, please join the chat (also reachable via IRC ), post them in our general discussion or read the current issues .\nIf you've found a bug, please create a new issue . If you would like a feature added to Shaarli, check the issues labeled feature , enhancement , and plugin . Note: This documentation is available online at https://shaarli.readthedocs.io/, and locally in the doc/html/ directory of your Shaarli installation.",
"title": "Shaarli documentation"
},
{
"location": "/#demo",
"text": "You can use this public demo instance of Shaarli .\nIt runs the latest development version of Shaarli and is updated/reset daily. Login: demo ; Password: demo",
"title": "Demo"
},
{
"location": "/#features",
"text": "",
"title": "Features"
},
{
"location": "/#interface",
"text": "minimalist design (simple is beautiful) FAST ATOM and RSS feeds views: paginated link list tag cloud picture wall: image and video thumbnails daily: newspaper-like daily digest daily RSS feed permalinks for easy reference links can be public or private extensible through plugins",
"title": "Interface"
},
{
"location": "/#tag-view-and-search-your-links",
"text": "add a custom title and description to archived links add tags to classify and search links features tag autocompletion, renaming, merging and deletion full-text and tag search",
"title": "Tag, view and search your links!"
},
{
"location": "/#easy-setup",
"text": "dead-simple installation: drop the files, open the page links are stored in a file compact storage no database required easy backup: simply copy the datastore file import and export links as Netscape bookmarks",
"title": "Easy setup"
},
{
"location": "/#accessibility",
"text": "Firefox bookmarlet to share links in one click support for mobile browsers works with Javascript disabled easy page customization through HTML/CSS/RainTPL",
"title": "Accessibility"
},
{
"location": "/#security",
"text": "bruteforce-proof login form protected against XSRF \nand session cookie hijacking",
"title": "Security"
},
{
"location": "/#goodies",
"text": "thumbnail generation for images and video services:\ndailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube... lazy-loading with bLazy PubSubHubbub protocol support URL cleanup: automatic removal of ?utm_source=... , fb=... discreet pop-up notification when a new release is available",
"title": "Goodies"
},
{
"location": "/#rest-api",
"text": "Easily extensible by any client using the REST API exposed by Shaarli. See the API documentation .",
"title": "REST API"
},
{
"location": "/#other-usages",
"text": "Though Shaarli is primarily a bookmarking application, it can serve other purposes\n(see usage examples ):\n- micro-blogging\n- pastebin\n- online notepad\n- snippet archive",
"title": "Other usages"
},
{
"location": "/#about",
"text": "",
"title": "About"
},
{
"location": "/#shaarli-community-fork",
"text": "This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli This is a community fork of the original Shaarli project by S\u00e9bastien Sauvage . The original project is currently unmaintained, and the developer has informed us \nthat he would have no time to work on Shaarli in the near future.\nThe Shaarli community has carried on the work to provide many patches \nfor bug fixes and enhancements \nin this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient.",
"title": "Shaarli community fork"
},
{
"location": "/#contributing",
"text": "If you'd like to help, please:\n- have a look at the open issues \nand pull requests \n- feel free to report bugs (feedback is much appreciated)\n- suggest new features and improvements to both code and documentation \n- propose solutions to existing problems\n- submit pull requests :-)",
"title": "Contributing"
},
{
"location": "/#license",
"text": "Shaarli is Free Software . See COPYING for a detail of the contributors and licenses for each individual component.",
"title": "License"
},
{
"location": "/Download-and-Installation/",
"text": "To install Shaarli, simply place the files in a directory under your webserver's Document Root (or directly at the document root). Make sure your \nserver\n is properly \nconfigured\n.\n\n\nSeveral releases are available:\n\n\n\n\nLatest release (recommended)\n\n\nDownload as an archive\n\n\nGet the latest released version from the \nreleases\n page.\n\n\nDownload our \nshaarli-full\n archive\n to include dependencies.\n\n\nThe current latest released version is \nv0.8.4\n\n\nOr in command lines:\n\n\n$ wget https://github.com/shaarli/Shaarli/releases/download/v0.8.4/shaarli-v0.8.4-full.zip\n$ unzip shaarli-v0.8.4-full.zip\n$ mv Shaarli /path/to/shaarli/\n\n\n\n\n\n\n\n\n\n\n!\n\n\nIn most cases, download Shaarli from the \nreleases\n page. Cloning using \ngit\n or downloading Github branches as zip files requires additional steps (see below).\n\n\n\n\n\n\n\n\n\n\nUsing git\n\n\nmkdir -p /path/to/shaarli && cd /path/to/shaarli/\ngit clone -b v0.8 https://github.com/shaarli/Shaarli.git .\ncomposer install --no-dev\n\n\n\n\n\n\nStable version\n\n\nThe stable version has been experienced by Shaarli users, and will receive security updates.\n\n\nDownload as an archive\n\n\nAs a .zip archive:\n\n\n$ wget https://github.com/shaarli/Shaarli/archive/stable.zip\n$ unzip stable.zip\n$ mv Shaarli-stable /path/to/shaarli/\n\n\n\n\nAs a .tar.gz archive :\n\n\n$ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz\n$ tar xvf stable.tar.gz\n$ mv Shaarli-stable /path/to/shaarli/\n\n\n\n\nClone with Git\n\n\nComposer\n is required to build a functional Shaarli installation when pulling from git.\n\n\n$ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/\n# install/update third-party dependencies\n$ cd /path/to/shaarli/\n$ composer install --no-dev\n\n\n\n\n\n\nDevelopment version (mainline)\n\n\nUse at your own risk!\n\n\nTo get the latest changes from the \nmaster\n branch:\n\n\n# clone the repository \n$ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/\n# install/update third-party dependencies\n$ cd /path/to/shaarli\n$ composer install --no-dev\n\n\n\n\n\n\nFinish Installation\n\n\nOnce Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.\n\n\n\n\nSetup your Shaarli installation, and it's ready to use!\n\n\n\n\nUpdating Shaarli\n\n\nSee \nUpgrade and Migration",
@ -1177,12 +1252,12 @@
},
{
"location": "/Release-Shaarli/",
"text": "See \nGit - Maintaining a project - Tagging your \nreleases\n.\n\n\nPrerequisites\n\n\nThis guide assumes that you have:\n- a GPG key matching your GitHub authentication credentials\n - i.e., the email address identified by the GPG key is the same as the one in your \n~/.gitconfig\n \n- a GitHub fork of Shaarli\n- a local clone of your Shaarli fork, with the following remotes:\n - \norigin\n pointing to your GitHub fork\n - \nupstream\n pointing to the main Shaarli repository\n- maintainer permissions on the main Shaarli repository, to:\n - push the signed tag\n - create a new release\n- \nComposer\n and \nPandoc\n need to be installed\n\n\nGitHub release draft and \nCHANGELOG.md\n\n\nSee http://keepachangelog.com/en/0.3.0/ for changelog formatting.\n\n\nGitHub release draft\n\n\nGitHub allows drafting the release note for the upcoming release, from the \nReleases\n page. This way, the release note can be drafted while contributions are merged to \nmaster\n.\n\n\nCHANGELOG.md\n\n\nThis file should contain the same information as the release note draft for the upcoming version.\n\n\nUpdate it to:\n- add new entries (additions, fixes, etc.)\n- mark the current version as released by setting its date and link\n- add a new section for the future unreleased version\n\n\n$ cd /path/to/shaarli\n\n$ nano CHANGELOG.md\n\n[...]\n## vA.B.C - UNRELEASED\nTBA\n\n## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD\n[...]\n\n\n\n\nIncrement the version code, updated docs, create and push a signed tag\n\n\nGenerate documentation\n\n\n$ cd /path/to/shaarli\n\n# create a new branch\n$ git fetch upstream\n$ git checkout upstream/master -b v0.5.0\n\n# rebuild the documentation from the wiki\n$ make htmldoc\n\n# commit the changes\n$ git add doc\n$ git commit -s -m \"Generate documentation for v0.5.0\"\n\n# push the commit on your GitHub fork\n$ git push origin v0.5.0\n\n\n\n\nCreate and merge a Pull Request\n\n\nThis one is pretty straightforward ;-)\n\n\nBump Shaarli version to v0.x branch\n\n\n$ git checkout master\n$ git fetch upstream\n$ git pull upstream master\n\n# IF the branch doesn't exists\n$ git checkout -b v0.5\n# OR if the branch already exists\n$ git checkout v0.5\n$ git rebase upstream/master\n\n# Bump shaarli version from dev to 0.5.0, **without the `v`**\n$ vim shaarli_version.php\n$ git add shaarli_version\n$ git commit -s -m \"Bump Shaarli version to v0.5.0\"\n$ git push upstream v0.5\n\n\n\n\nCreate and push a signed tag\n\n\n# update your local copy\n$ git checkout v0.5\n$ git fetch upstream\n$ git pull upstream v0.5\n\n# create a signed tag\n$ git tag -s -m \"Release v0.5.0\" v0.5.0\n\n# push it to \"upstream\"\n$ git push --tags upstream\n\n\n\n\nVerify a signed tag\n\n\nv0.5.0\n is the first GPG-signed tag pushed on the Community Shaarli.\n\n\nLet's have a look at its signature!\n\n\n$ cd /path/to/shaarli\n$ git fetch upstream\n\n# get the SHA1 reference of the tag\n$ git show-ref tags/v0.5.0\nf7762cf803f03f5caf4b8078359a63783d0090c1 refs/tags/v0.5.0\n\n# verify the tag signature information\n$ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1\ngpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F\ngpg: Good signature from \"VirtualTam <virtualtam@flibidi.net>\" [ultimate]\n\n\n\n\nPublish the GitHub release\n\n\nUpdate release badges\n\n\nUpdate \nREADME.md\n so version badges display and point to the newly released Shaarli version(s), in the \nmaster\n branch.\n\n\nCreate a GitHub release from a Git tag\n\n\nFrom the previously drafted release:\n- edit the release notes (if needed)\n- specify the appropriate Git tag\n- publish the release\n- profit!\n\n\nGenerate and upload all-in-one release archives\n\n\nUsers with a shared hosting may have:\n- no SSH access\n- no possibility to install PHP packages or server extensions\n- no possibility to run scripts\n\n\nTo ease Shaarli installations, it is possible to generate and upload additional release archives,\nthat will contain Shaarli code plus all required third-party libraries.\n\n\nFrom the \nv0.5\n branch:\n\n\n$ make release_archive\n\n\n\n\nThis will create the following archives:\n- \nshaarli-vX.Y.Z-full.tar\n\n- \nshaarli-vX.Y.Z-full.zip\n\n\nThe archives need to be manually uploaded on the previously created GitHub release.\n\n\nUpdate \nstable\n and \nlatest\n branches\n\n\n$ git checkout latest\n# latest release\n$ git merge v0.5.0\n# fix eventual conflicts\n$ make test\n$ git push upstream latest\n$ git checkout stable\n# latest previous major\n$ git merge v0.4.5 \n# fix eventual conflicts\n$ make test\n$ git push upstream stable",
"text": "See \nGit - Maintaining a project - Tagging your \nreleases\n.\n\n\nPrerequisites\n\n\nThis guide assumes that you have:\n- a GPG key matching your GitHub authentication credentials\n - i.e., the email address identified by the GPG key is the same as the one in your \n~/.gitconfig\n \n- a GitHub fork of Shaarli\n- a local clone of your Shaarli fork, with the following remotes:\n - \norigin\n pointing to your GitHub fork\n - \nupstream\n pointing to the main Shaarli repository\n- maintainer permissions on the main Shaarli repository, to:\n - push the signed tag\n - create a new release\n- \nComposer\n needs to be installed\n- The \nvenv\n Python 3 module needs to be installed for HTML documentation generation.\n\n\nGitHub release draft and \nCHANGELOG.md\n\n\nSee http://keepachangelog.com/en/0.3.0/ for changelog formatting.\n\n\nGitHub release draft\n\n\nGitHub allows drafting the release note for the upcoming release, from the \nReleases\n page. This way, the release note can be drafted while contributions are merged to \nmaster\n.\n\n\nCHANGELOG.md\n\n\nThis file should contain the same information as the release note draft for the upcoming version.\n\n\nUpdate it to:\n- add new entries (additions, fixes, etc.)\n- mark the current version as released by setting its date and link\n- add a new section for the future unreleased version\n\n\n$ cd /path/to/shaarli\n\n$ nano CHANGELOG.md\n\n[...]\n## vA.B.C - UNRELEASED\nTBA\n\n## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD\n[...]\n\n\n\n\nIncrement the version code, updated docs, create and push a signed tag\n\n\nGenerate documentation\n\n\n$ cd /path/to/shaarli\n\n# create a new branch\n$ git fetch upstream\n$ git checkout upstream/master -b v0.5.0\n\n# rebuild the HTML documentation from Markdown\n$ make htmlpages\n\n# commit the changes\n$ git add doc\n$ git commit -s -m \"Generate documentation for v0.5.0\"\n\n# push the commit on your GitHub fork\n$ git push origin v0.5.0\n\n\n\n\nCreate and merge a Pull Request\n\n\nThis one is pretty straightforward ;-)\n\n\nBump Shaarli version to v0.x branch\n\n\n$ git checkout master\n$ git fetch upstream\n$ git pull upstream master\n\n# IF the branch doesn't exists\n$ git checkout -b v0.5\n# OR if the branch already exists\n$ git checkout v0.5\n$ git rebase upstream/master\n\n# Bump shaarli version from dev to 0.5.0, **without the `v`**\n$ vim shaarli_version.php\n$ git add shaarli_version\n$ git commit -s -m \"Bump Shaarli version to v0.5.0\"\n$ git push upstream v0.5\n\n\n\n\nCreate and push a signed tag\n\n\n# update your local copy\n$ git checkout v0.5\n$ git fetch upstream\n$ git pull upstream v0.5\n\n# create a signed tag\n$ git tag -s -m \"Release v0.5.0\" v0.5.0\n\n# push it to \"upstream\"\n$ git push --tags upstream\n\n\n\n\nVerify a signed tag\n\n\nv0.5.0\n is the first GPG-signed tag pushed on the Community Shaarli.\n\n\nLet's have a look at its signature!\n\n\n$ cd /path/to/shaarli\n$ git fetch upstream\n\n# get the SHA1 reference of the tag\n$ git show-ref tags/v0.5.0\nf7762cf803f03f5caf4b8078359a63783d0090c1 refs/tags/v0.5.0\n\n# verify the tag signature information\n$ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1\ngpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F\ngpg: Good signature from \"VirtualTam <virtualtam@flibidi.net>\" [ultimate]\n\n\n\n\nPublish the GitHub release\n\n\nUpdate release badges\n\n\nUpdate \nREADME.md\n so version badges display and point to the newly released Shaarli version(s), in the \nmaster\n branch.\n\n\nCreate a GitHub release from a Git tag\n\n\nFrom the previously drafted release:\n- edit the release notes (if needed)\n- specify the appropriate Git tag\n- publish the release\n- profit!\n\n\nGenerate and upload all-in-one release archives\n\n\nUsers with a shared hosting may have:\n- no SSH access\n- no possibility to install PHP packages or server extensions\n- no possibility to run scripts\n\n\nTo ease Shaarli installations, it is possible to generate and upload additional release archives,\nthat will contain Shaarli code plus all required third-party libraries.\n\n\nFrom the \nv0.5\n branch:\n\n\n$ make release_archive\n\n\n\n\nThis will create the following archives:\n- \nshaarli-vX.Y.Z-full.tar\n\n- \nshaarli-vX.Y.Z-full.zip\n\n\nThe archives need to be manually uploaded on the previously created GitHub release.\n\n\nUpdate \nstable\n and \nlatest\n branches\n\n\n$ git checkout latest\n# latest release\n$ git merge v0.5.0\n# fix eventual conflicts\n$ make test\n$ git push upstream latest\n$ git checkout stable\n# latest previous major\n$ git merge v0.4.5 \n# fix eventual conflicts\n$ make test\n$ git push upstream stable",
"title": "Release Shaarli"
},
{
"location": "/Release-Shaarli/#prerequisites",
"text": "This guide assumes that you have:\n- a GPG key matching your GitHub authentication credentials\n - i.e., the email address identified by the GPG key is the same as the one in your ~/.gitconfig \n- a GitHub fork of Shaarli\n- a local clone of your Shaarli fork, with the following remotes:\n - origin pointing to your GitHub fork\n - upstream pointing to the main Shaarli repository\n- maintainer permissions on the main Shaarli repository, to:\n - push the signed tag\n - create a new release\n- Composer and Pandoc need to be installed",
"text": "This guide assumes that you have:\n- a GPG key matching your GitHub authentication credentials\n - i.e., the email address identified by the GPG key is the same as the one in your ~/.gitconfig \n- a GitHub fork of Shaarli\n- a local clone of your Shaarli fork, with the following remotes:\n - origin pointing to your GitHub fork\n - upstream pointing to the main Shaarli repository\n- maintainer permissions on the main Shaarli repository, to:\n - push the signed tag\n - create a new release\n- Composer needs to be installed\n- The venv Python 3 module needs to be installed for HTML documentation generation.",
"title": "Prerequisites"
},
{
@ -1207,7 +1282,7 @@
},
{
"location": "/Release-Shaarli/#generate-documentation",
"text": "$ cd /path/to/shaarli\n\n# create a new branch\n$ git fetch upstream\n$ git checkout upstream/master -b v0.5.0\n\n# rebuild the documentation from the wiki\n$ make htmldoc\n\n# commit the changes\n$ git add doc\n$ git commit -s -m \"Generate documentation for v0.5.0\"\n\n# push the commit on your GitHub fork\n$ git push origin v0.5.0",
"text": "$ cd /path/to/shaarli\n\n# create a new branch\n$ git fetch upstream\n$ git checkout upstream/master -b v0.5.0\n\n# rebuild the HTML documentation from Markdown\n$ make htmlpages\n\n# commit the changes\n$ git add doc\n$ git commit -s -m \"Generate documentation for v0.5.0\"\n\n# push the commit on your GitHub fork\n$ git push origin v0.5.0",
"title": "Generate documentation"
},
{

72
doc/html/sitemap.xml
View file

@ -4,7 +4,7 @@
<url>
<loc>/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
@ -13,43 +13,43 @@
<url>
<loc>/Download-and-Installation/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Upgrade-and-migration/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Server-requirements/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Server-configuration/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Server-security/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Shaarli-configuration/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Plugins/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
@ -59,25 +59,25 @@
<url>
<loc>/Docker-101/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Shaarli-images/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Reverse-proxy-configuration/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Docker-resources/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
@ -87,37 +87,37 @@
<url>
<loc>/Features/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Bookmarklet/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Browsing-and-searching/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Firefox-share/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/RSS-feeds/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/REST-API/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
@ -127,13 +127,13 @@
<url>
<loc>/Backup,-restore,-import-and-export/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Various-hacks/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
@ -142,7 +142,7 @@
<url>
<loc>/Troubleshooting/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
@ -151,79 +151,79 @@
<url>
<loc>/Development-guidelines/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Continuous-integration-tools/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/GnuPG-signature/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Coding-guidelines/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Directory-structure/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/3rd-party-libraries/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Plugin-System/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Release-Shaarli/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Versioning-and-Branches/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Security/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Static-analysis/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Theming/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Unit-tests/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
@ -233,13 +233,13 @@
<url>
<loc>/FAQ/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Community-&-Related-software/</loc>
<lastmod>2017-06-18</lastmod>
<lastmod>2017-07-04</lastmod>
<changefreq>daily</changefreq>
</url>