VladPolskiy/postgres-web
1
0
Fork 0
mirror of https://github.com/postgres/pgweb.git synced 2025-08-01 15:54:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update language on "Submit Documentation Comment" page.

Browse Source 
The language is more thorough in describing how to use the form,
in an effort to help improve the overall quality of submissions to
pgsql-docs.
This commit is contained in:
Jonathan S. Katz
2018-04-15 13:16:05 -04:00
parent 872d8b8e76
commit 68ee1d6f1d
3 changed files with 22 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
pgweb/docs/forms.py
View File

@ -1,9 +1,8 @@
from django import forms
class DocCommentForm(forms.Form):
name = forms.CharField(max_length=100, required=True)
email = forms.EmailField(max_length=100, required=True, label="Your email")
shortdesc = forms.CharField(max_length=100, required=True,
label="Email subject")
name = forms.CharField(max_length=100, required=True, label='Your Name')
email = forms.EmailField(max_length=100, required=True, label='Your Email')
shortdesc = forms.CharField(max_length=100, required=True, label="Subject")
details = forms.CharField(required=True, widget=forms.Textarea,
label="Email body")
label="What is your comment?")

4
pgweb/docs/views.py
View File

@ -157,10 +157,10 @@ def commentform(request, itemid, version, filename):
return render_pgweb(request, 'docs', 'base/form.html', {
'form': form,
'formitemtype': 'documentation correction',
'formitemtype': 'documentation comment',
'operation': 'Submit',
'form_intro': template_to_string('docs/docsbug.html', {
'user': request.user,
}),
'savebutton': 'Send email',
'savebutton': 'Send Email',
})

21
templates/docs/docsbug.html
View File

@ -1,5 +1,16 @@
By submitting a documentation correction through this form you agree
that all contents of the report, including your personal information
as listed, will be posted to the <b>public</b>
<a href="/list/pgsql-docs/">pgsql-docs</a> mailing list, and archived in the
<b>public</b> list archives.
<p>
Found something in the documentation that is incorrect, does not match your
experience with a particular feature, or requires further clarification?
</p>
<p>
Please fill out the form below with your name, email, subject, and a detailed
description about what you are commenting on. After clicking the button below,
an email will be sent to the
<a href="/list/pgsql-docs/">pgsql-docs@postgresql.org</a> mailing list.
</p>
<p>
By submitting this form, you agree that all of its contents, including your
personal information as listed, will be posted to the <strong>public</strong>
<a href="/list/pgsql-docs/">pgsql-docs@postgresql.org</a> mailing list, and
archived in the <strong>public</strong> list archives.
</p>