forked from ebean-orm/website-source
-
Notifications
You must be signed in to change notification settings - Fork 0
/
support.html
122 lines (107 loc) · 3.69 KB
/
support.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
<html>
<head>
<title>Getting help | Ebean</title>
<meta name="layout" content="_layout/docs_intro.html"/>
<meta name="layout" content="_layout2/base-docs.html"/>
<meta name="bread1" content="getting help" href="/docs/support"/>
<#assign n0_support="active">
</head>
<body>
<h2>Getting help</h2>
<p>
For help post questions and issues to the <a href="https://groups.google.com/forum/#!forum/ebean">Ebean google
group</a>.
</p>
<h2 id="github">Github Issues Policy</h2>
<table class="table">
<tr>
<th>Quality</th>
<td>Issues posted to Github of insufficient quality will be removed.</td>
</tr>
<tr>
<th>No protracted discussions</th>
<td>
Issues likely to result in protracted discussion must
be posted to the <a href="https://groups.google.com/forum/#!forum/ebean">Ebean google group</a>.
</td>
</tr>
<tr>
<th>No questions</th>
<td>
Do not post questions as Github issues. These will be removed and you will be asked to post
questions to the <a href="https://groups.google.com/forum/#!forum/ebean">Ebean google group</a> instead.
</td>
</tr>
</table>
<h3>Why this Policy exists</h3>
<h5>Avoid spamming Watchers</h5>
<p>
People register to <code>watch</code> the github issues register to keep track of changes to the
project. As such protracted discussions effectively spam all these people watching the project
and we don't want that.
</p>
<h5>Quality searching</h5>
<p>
We want to be able to search the github issues now and in the long term and we want those searches
to result in high quality results. As such we want issues to relate closely to actual commits.
</p>
<h5>Future readers</h5>
<p>
We want to avoid low quality issues with protracted discussions as these become much more difficult
to read and understand
</p>
<h2>Ebean google group</h2>
<p>
Post questions or issues to the <a href="https://groups.google.com/forum/#!forum/ebean">Ebean google
group</a>. This
is monitored by Ebean developers and it's most experienced users and here you will get the best help.
</p>
<h3>Stackoverflow</h3>
<p>
You can alternatively post questions on <a href="http://stackoverflow.com/questions/tagged/ebean">Stack
Overflow</a>
tagged with <code>ebean</code>. Note that stackoverflow is more casually monitored due to time constraints.
It
is fine if you want to post first to stackoverflow and then if you don't get an answer to post onto the
google
group.
</p>
<h2>Github issues</h2>
<p>
For this project we want to use Github issues for <code>Bugs</code>, <code>Enhancements</code> and
<code>Refactoring</code> changes. That is, things that mostly tie back to a specific commit change in code.
</p>
<ul>
<li>
Complex issues must be discussed on <a href="https://groups.google.com/forum/#!forum/ebean">Ebean google
group</a>
first to avoid spamming watchers.
</li>
<li>
Questions posted to github will be closed and content cleared.
</li>
<li>
Low quality issues posted to github will be closed and content cleared.
</li>
</ul>
<h4>
In short, always post to <a href="https://groups.google.com/forum/#!forum/ebean">Ebean google group</a>
first.
</h4>
<h3>Code Examples</h3>
<p>
The <a href="https://github.com/ebean-orm-examples">ebean-orm-examples</a> group contains several example
applications from absolute minimal, spring-boot to jax-rs web apps so you can look at those for example
code.
</p>
<h3>Documentation</h3>
<ul>
<li><a href="/docs">Reference documentation</a></li>
<li><a target="_blank" href="/apidoc/13">Javadoc API documentation</a></li>
</ul>
<h3>Videos</h3>
<p>
Checkout of the <a href="/videos">videos</a> for a quick view on how certain features work.
</p>
</body>
</html>