aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/Development.html
diff options
context:
space:
mode:
authorVirtualTam <virtualtam@flibidi.net>2015-07-22 05:02:10 +0200
committerVirtualTam <virtualtam@flibidi.net>2015-08-04 16:02:21 +0200
commit992af0b9d77cb4fbac2c37ef8d5896042d67a2a3 (patch)
tree4726baf18e7057eac3f9b6bdb5991fe6117814fc /doc/Development.html
parent96db105e4c0833324f7168edb5673278de8ccd54 (diff)
downloadShaarli-992af0b9d77cb4fbac2c37ef8d5896042d67a2a3.tar.gz
Shaarli-992af0b9d77cb4fbac2c37ef8d5896042d67a2a3.tar.zst
Shaarli-992af0b9d77cb4fbac2c37ef8d5896042d67a2a3.zip
Doc: sync from Wiki, generate HTML
Closes #291 Fixes #227 Modifications - HTML content: match the new Wiki structure - Makefile - generate a custom HTML sidebar - include the sidebar on all pages - infer and prepend page titles - handle relative links - add title metadata, e.g. Shaarli - <Page Name> Signed-off-by: VirtualTam <virtualtam@flibidi.net>
Diffstat (limited to 'doc/Development.html')
-rw-r--r--doc/Development.html102
1 files changed, 102 insertions, 0 deletions
diff --git a/doc/Development.html b/doc/Development.html
new file mode 100644
index 00000000..1e33eff4
--- /dev/null
+++ b/doc/Development.html
@@ -0,0 +1,102 @@
1<!DOCTYPE html>
2<html>
3<head>
4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - Development</title>
8 <style type="text/css">code{white-space: pre;}</style>
9 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <link rel="stylesheet" href="github-markdown.css">
13</head>
14<body>
15<div id="local-sidebar">
16<ul>
17<li><a href="Home.html">Home</a></li>
18<li>Installation
19<ul>
20<li><a href="Server-requirements.html">Server requirements</a></li>
21<li><a href="Server-configuration.html">Server configuration</a></li>
22<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
23</ul></li>
24<li><a href="Usage.html">Usage</a>
25<ul>
26<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
27<li><a href="Firefox-share.html">Firefox share</a></li>
28<li><a href="RSS-feeds.html">RSS feeds</a></li>
29</ul></li>
30<li>How To
31<ul>
32<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
33<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
34<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
35</ul></li>
36<li><a href="Troubleshooting.html">Troubleshooting</a></li>
37<li><a href="Development.html">Development</a>
38<ul>
39<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
40<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
41<li><a href="Directory-structure.html">Directory structure</a></li>
42<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
43<li><a href="Plugin-System.html">Plugin System</a></li>
44<li><a href="Security.html">Security</a></li>
45<li><a href="Static-analysis.html">Static analysis</a></li>
46<li><a href="Theming.html">Theming</a></li>
47<li><a href="Unit-tests.html">Unit tests</a></li>
48</ul></li>
49<li>About
50<ul>
51<li><a href="FAQ.html">FAQ</a></li>
52<li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
53<li><a href="TODO.html">TODO</a></li>
54</ul></li>
55</ul>
56</div>
57<h1 id="development">Development</h1>
58<h2 id="guidelines">Guidelines</h2>
59<p>Please have a look at the following pages:</p>
60<ul>
61<li><a href="https://github.com/shaarli/Shaarli/tree/master/CONTRIBUTING.md">Contributing to Shaarli</a><a href=".html"></a></li>
62<li><a href="Static-analysis.html">Static analysis</a> - patches should try to stick to the <a href="http://www.php-fig.org/psr/">PHP Standard Recommendations</a> (PSR), especially:
63<ul>
64<li><a href="http://www.php-fig.org/psr/psr-1/">PSR-1</a> - Basic Coding Standard<a href=".html"></a></li>
65<li><a href="http://www.php-fig.org/psr/psr-2/">PSR-2</a> - Coding Style Guide<a href=".html"></a></li>
66</ul></li>
67<li><a href="Unit-tests.html">Unit tests</a></li>
68<li><a href="GnuPG-signature.html">GnuPG signature</a> for tags/releases</li>
69</ul>
70<h2 id="continuous-integration-tools">Continuous integration tools</h2>
71<h3 id="local-development">Local development</h3>
72<p>A <a href="https://github.com/shaarli/Shaarli/blob/master/Makefile"><code>Makefile</code></a> is available to perform project-related operations:<a href=".html"></a></p>
73<ul>
74<li>Documentation - generate a local HTML copy of the GitHub wiki</li>
75<li><a href="Static-analysis.html">Static analysis</a> - check that the code is compliant to PHP conventions</li>
76<li><a href="Unit-tests.html">Unit tests</a> - ensure there are no regressions introduced by new commits</li>
77</ul>
78<h3 id="automatic-builds">Automatic builds</h3>
79<p><a href="http://docs.travis-ci.com/">Travis CI</a> is a Continuous Integration build server, that runs a build:<a href=".html"></a></p>
80<ul>
81<li>each time a commit is merged to the mainline (<code>master</code> branch)</li>
82<li>each time a Pull Request is submitted or updated</li>
83</ul>
84<p>A build is composed of several jobs: one for each supported PHP version (see <a href="Server-requirements.html">Server requirements</a>).</p>
85<p>Each build job:</p>
86<ul>
87<li>updates Composer</li>
88<li>installs 3rd-party test dependencies with Composer</li>
89<li>runs <a href="Unit-tests.html">Unit tests</a></li>
90</ul>
91<p>After all jobs have finished, Travis returns the results to GitHub:</p>
92<ul>
93<li>a status icon represents the result for the <code>master</code> branch: <a href="(https://api.travis-ci.org/shaarli/Shaarli.svg)](https://travis-ci.org/shaarli/Shaarli).html"><img src="https://travis-ci.org/shaarli/Shaarli" alt="(https://api.travis-ci.org/shaarli/Shaarli.svg)" /></a></li>
94<li>Pull Requests are updated with the Travis result
95<ul>
96<li>Green: all tests have passed</li>
97<li>Red: some tests failed</li>
98<li>Orange: tests are pending</li>
99</ul></li>
100</ul>
101</body>
102</html>