wallabag/docs/en/help_wallabag.html

235 lines
15 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>wallabag - Help wallabag</title>
<link rel="stylesheet" href="http://doc.wallabag.org/css/bootstrap.min.css">
<link rel="stylesheet" href="http://doc.wallabag.org/css/font-awesome.min.css">
<link rel="stylesheet" href="http://doc.wallabag.org/css/highlight.tomorrow-night.css">
<link rel="stylesheet" href="http://doc.wallabag.org/css/main.css">
</head>
<body>
<header class="navbar navbar-default navbar-fixed-top">
<a class="navbar-brand" href="http://doc.wallabag.org/">
wallabag
<small class="hidden-xs hidden-sm">
Help wallabag
</small>
</a>
<a href="http://doc.wallabag.org/en">EN</a> - <a href="http://doc.wallabag.org/fr">FR</a> - <a href="http://doc.wallabag.org/de">DE</a> - <a href="http://doc.wallabag.org/ru">RU</a>
</header>
<main class="container-fluid">
<div class="row">
<nav id="sidebar" class="col-sm-3 col-lg-2" role="navigation">
<ul class="nav nav-pills nav-stacked">
<h4 class="text-muted">
</h4>
<ul class="nav nav-pills nav-stacked">
<li class="test ">
<a href="http://doc.wallabag.org/en/index.html">
Getting started
</a>
</li>
<li class="test active">
<a href="http://doc.wallabag.org/en/help_wallabag.html">
Help us
</a>
</li>
</ul>
<h4 class="text-muted">
Administrator
</h4>
<ul class="nav nav-pills nav-stacked">
<li class="test ">
<a href="http://doc.wallabag.org/en/Administrator/download_and_install.html">
Download and installation
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/Administrator/update.html">
Update wallabag
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/Administrator/hidden_options.html">
Hidden options
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/Administrator/multiusers.html">
Multi users
</a>
</li>
</ul>
<h4 class="text-muted">
User
</h4>
<ul class="nav nav-pills nav-stacked">
<li class="test ">
<a href="http://doc.wallabag.org/en/User/save_your_first_article.html">
Save your first article
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/User/read_an_article.html">
Read an article
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/User/organize_articles.html">
Organize articles
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/User/configure_wallabag.html">
Configure wallabag
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/User/search.html">
Search
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/User/epub_conversion.html">
ePub conversion
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/User/issue_with_article.html">
Issue with article
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/User/rss_feed.html">
RSS feed
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/User/import_export.html">
Import export
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/User/framabag_account_creation.html">
Framabag account creation
</a>
</li>
</ul>
<h4 class="text-muted">
Developer
</h4>
<ul class="nav nav-pills nav-stacked">
<li class="test ">
<a href="http://doc.wallabag.org/en/Developer/write_config_files.html">
Write config files
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/Developer/create_new_theme.html">
Create a new theme
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/Developer/git_repo.html">
Git repository
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/Developer/docker.html">
Docker
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/Developer/vagrant.html">
Vagrant
</a>
</li>
<li class="test ">
<a href="http://doc.wallabag.org/en/Developer/v2.html">
wallabag v2 / symfony2
</a>
</li>
</ul>
</ul>
</nav>
<section class="col-lg-10">
<h1 id="help-wallabag">Help wallabag</h1>
<h2 id="report-bugs">Report bugs</h2>
<h3 id="contact-wallabag-support">Contact wallabag support</h3>
<p>If you have a problem while installation or using wallabag (either with the web application or the smartphone applications), use the support site <a href="http://support.wallabag.org"><a href="http://support.wallabag.org">http://support.wallabag.org</a></a>.</p>
<p>We will look if we can do to help you promptly, or if it is an new bug that we will need to correct.</p>
<p>It is better to use the support site than sending us an email: the followup is easier for us and the solution to your problem may help another user.</p>
<h3 id="create-a-new-issue">Create a new issue</h3>
<p>If you find a bug during wallabag use, thanks for opening a new issue on Github (an account is required).</p>
<p><strong>First of all</strong>, read the <a href="https://github.com/wallabag/wallabag/blob/master/contributing.html">advices about the submission of a new issue</a>. The better you report the issue, the more we will be able to help you.</p>
<ul>
<li>for a bug in the web application, <a href="https://github.com/wallabag/wallabag/issues/new">open a new issue here</a></li>
<li>for a bug in the Android application, <a href="https://github.com/wallabag/android-app/issues/new">open a new issue here</a></li>
<li>for a bug in the Windows Phone application, <a href="https://github.com/wallabag/windowsphone-app">open a new issue here</a></li>
<li>for a bug in the iOS application , <a href="https://github.com/wallabag/ios-app/issues/new">open a new issue here</a></li>
<li>for a bug in the Firefox extension, <a href="https://github.com/wallabag/firefox-ext/issues/new">open a new issue here</a></li>
<li>for a bug in the Chrome extension, <a href="https://github.com/wallabag/chrome-ext/issues/new">open a new issue here</a></li>
</ul>
<h2 id="write-and-fix-documentation">Write and fix documentation</h2>
<p>The documentation you are reading is likely to miss some points, to be out-of-date, to require a translation in your language. Hence, we invite you to take part in its writing.</p>
<p>The Github repository is here: <a href="https://github.com/wallabag/documentation"><a href="https://github.com/wallabag/documentation">https://github.com/wallabag/documentation</a></a>.</p>
<h2 id="fix-bugs">Fix bugs</h2>
<p>Two options:</p>
<ul>
<li>when a wallabag user asks a new question <a href="http://support.wallabag.org">on the support site</a>, you could answer him directly if you are a more advanced wallabag user.</li>
<li>on Github, some issues are likely to match your skills. <a href="https://github.com/wallabag/wallabag/issues">Go through the issue list</a> and help yourself.</li>
</ul>
<p>You are welcome to suggest changes to the wallabag code. Look at the <a href="https://github.com/wallabag/wallabag/blob/master/contributing.html">advices about the submission of a new issue</a>.</p>
<h2 id="spread-the-word">Spread the word</h2>
<p>It's not so complicated: just talk about wallabag! Use #wallabag hashtag on all your social networks: twitter, Facebook, Diaspora*, Google+, etc.</p>
<p>Here are our accounts on social networks:</p>
<ul>
<li><a href="https://framasphere.org/people/2335ff202f920132196e2a0000053625">Diaspora*</a></li>
<li><a href="https:/twitter.com/wallabagapp">twitter</a></li>
<li><a href="https://www.facebook.com/wallabag">Facebook</a></li>
<li><a href="https://plus.google.com/+WallabagOrg/">Google+</a></li>
</ul>
</section>
</div>
</main>
<script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
<script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
<script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
<script>
$(function() {
$("section>h1").wrap('<div class="page-header" />');
// Syntax highlighting
hljs.initHighlightingOnLoad();
});
</script>
</body>
</html>