Skip to content

Commit 471baf4

Browse files
WIP (#524)
Co-authored-by: Daksh Bhayana <[email protected]>
1 parent de08ff0 commit 471baf4

24 files changed

+123
-123
lines changed

doc/_templates/index.html

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{% extends "layout.html" %}
22
{% set title = 'Overview' %}
33
{% block body %}
4-
<h1>Welcome to pretix' documentation!</h1>
4+
<h1>Welcome to the documentation of the eventyay tickets component!</h1>
55
<p>
66
We work hard to make this website contain all information that you need to use, run, understand, and improve
7-
pretix. Of course, this documentation will never be perfect or complete, but if there is anything unclear
7+
eventyay. Of course, this documentation will never be perfect or complete, but if there is anything unclear
88
or anything specific that you miss here, that's a bug and we'd be happy if you'd
9-
<a href="https://github.com/pretix/pretix/issues/new">let us know</a>.
9+
<a href="https://github.com/fossasia/eventyay-tickets/issues/new">let us know</a>.
1010
</p>
1111

1212
<h2>Documentation structure</h2>
@@ -34,7 +34,7 @@ <h2>Documentation structure</h2>
3434
<a href="admin/index.html">
3535
<strong>Administrator docs</strong>
3636
</a>
37-
<p>Find out how to install eventyay on your own server and how to maintain an installation of pretix.</p>
37+
<p>Find out how to install eventyay on your own server and how to maintain an installation of eventyay.</p>
3838
</div>
3939
</div>
4040
<div class="clearfix"></div>
@@ -65,7 +65,7 @@ <h2>Documentation structure</h2>
6565
<strong>Developer docs</strong>
6666
</a>
6767
<p>Get information on how to contribute to eventyay itself and how to build plugins that interact with
68-
pretix.</p>
68+
eventyay.</p>
6969
</div>
7070
</div>
7171
<div class="clearfix"></div>
@@ -114,12 +114,12 @@ <h2>Useful links</h2>
114114
</div>
115115
<div class="sectionbox">
116116
<div class="icon">
117-
<a href="https://github.com/pretix/pretix" target="_blank">
117+
<a href="https://github.com/fossasia/eventyay-tickets" target="_blank">
118118
<span class="fa fa-github fa-fw"></span>
119119
</a>
120120
</div>
121121
<div class="text">
122-
<a href="https://github.com/pretix/pretix" target="_blank">
122+
<a href="https://github.com/fossasia/eventyay-tickets" target="_blank">
123123
<strong>GitHub repository</strong>
124124
</a>
125125
<p>The source code repository contains the code that is part of eventyay tickets as well as other components, plugins and the
@@ -129,25 +129,25 @@ <h2>Useful links</h2>
129129
<div class="clearfix"></div>
130130
<div class="sectionbox">
131131
<div class="icon">
132-
<a href="https://eventyay.com/about/en/blog/" target="_blank">
132+
<a href="https://blog.eventyay.com/" target="_blank">
133133
<span class="fa fa-newspaper-o fa-fw"></span>
134134
</a>
135135
</div>
136136
<div class="text">
137-
<a href="https://eventyay.com/about/en/blog/" target="_blank">
137+
<a href="https://blog.eventyay.com/" target="_blank">
138138
<strong>Project blog</strong>
139139
</a>
140140
<p>This essential resource provides all release notes for stable eventyay releases, along with general news and updates.</p>
141141
</div>
142142
</div>
143143
<div class="sectionbox">
144144
<div class="icon">
145-
<a href="https://twitter.com/pretixeu" target="_blank">
145+
<a href="https://twitter.com/eventyay" target="_blank">
146146
<span class="fa fa-twitter fa-fw"></span>
147147
</a>
148148
</div>
149149
<div class="text">
150-
<a href="https://twitter.com/pretixeu" target="_blank">
150+
<a href="https://twitter.com/eventyay" target="_blank">
151151
<strong>Twitter</strong>
152152
</a>
153153
<p>Keep in touch and stay up to date by following our project account on Twitter.</p>

doc/plugins/webinar.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
pretix Webinar
1+
eventyay Webinar
22
==============
33

44
Fetch host URLs

doc/user/events/create.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Creating an event
44
=================
55

66
After you have created an organizer account, the next step is to create your event. An event is the basic object in
7-
pretix that everything is organized around. One event corresponds to one ticket shop with all its products, quotas,
7+
eventyay that everything is organized around. One event corresponds to one ticket shop with all its products, quotas,
88
orders and settings.
99

1010
To create an event, you can click the "Create a new event" tile on your dashboard or the button above the list of

doc/user/events/email.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
E-mail settings
22
===============
33

4-
The settings at "Settings" → "E-mail" allow you to customize the emails that pretix sends to the participants of your
4+
The settings at "Settings" → "E-mail" allow you to customize the emails that eventyay sends to the participants of your
55
event.
66

77
.. thumbnail:: ../../screens/event/settings_email.png
@@ -48,7 +48,7 @@ Sales Channels for Checkout Emails
4848
E-mail design
4949
-------------
5050

51-
In this part, you can choose and preview the layout of your emails. More layouts can be added by pretix plugins.
51+
In this part, you can choose and preview the layout of your emails. More layouts can be added by eventyay plugins.
5252

5353
E-mail content
5454
--------------
@@ -139,7 +139,7 @@ Order canceled
139139

140140

141141
Order custom mail
142-
You can use pretix' admin interface to directly send an e-mail with a custom text to the customer of a specific
142+
You can use eventyay' admin interface to directly send an e-mail with a custom text to the customer of a specific
143143
order. In this case, this will be the default text and might save you time by not having to re-type all of it every
144144
time.
145145

@@ -168,7 +168,7 @@ SMTP settings
168168
-------------
169169

170170
If you want to send your e-mails via your own e-mail address, we strongly recommend to use SMTP for this purpose.
171-
SMTP is a protocol that is used by e-mail clients to communicate with e-mail servers. Using SMTP, pretix can talk to
171+
SMTP is a protocol that is used by e-mail clients to communicate with e-mail servers. Using SMTP, eventyay can talk to
172172
your e-mail service provider the same way that e.g. the e-mail app on your phone can.
173173

174174
Your e-mail provider will most likely have a document that tells you the settings for the various fields to fill in
@@ -184,7 +184,7 @@ Spam issues
184184
If you use an email address of your own domain as a sender address and do not use a custom SMTP server, it is very
185185
likely that at least some of your emails will go to the spam folders of their recipients. We **strongly recommend**
186186
to use your organization's SMTP server in this case, making your email really come from your organization. If you don't
187-
want that or cannot do that, you should add the pretix application server to your SPF record.
187+
want that or cannot do that, you should add the eventyay application server to your SPF record.
188188

189189
If you are using our hosted service at eventyay.com, you can add the following to your SPF record::
190190

@@ -195,7 +195,7 @@ A complete record could look like this::
195195
v=spf1 a mx include:_spf.eventyay.com ~all
196196

197197
Make sure to read up on the `SPF specification`_. If you want to authenticate your emails with DKIM, set up a DNS TXT
198-
record for the subdomain ``pretix._domainkey`` with the following contents::
198+
record for the subdomain ``eventyay._domainkey`` with the following contents::
199199

200200
v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDXrDk6lwOWX00e2MbiiJac6huI+gnzLf9N4G1FnBv3PXq8fz3i2q1szH72OF5mAlKm3zXO4cl/uxx+lfidS1ERbX6Bn9BRstBTQUKWC4JFj8Yk9+fwT7LWehDURazLdTzfsIjJFudLLvxtOKSaOCtMhbPX05DIhziaqVCBqgz/NQIDAQAB
201201

doc/user/events/giftcards.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -14,31 +14,31 @@ can later be used to pay for tickets.
1414
Gift cards are very different feature than **vouchers**. The difference is:
1515

1616
* Vouchers can be used to give a discount. When a voucher is used, the price of a ticket is reduced by the configured
17-
discount and sold at a lower price. They therefore reduce both revenue as well as taxes. Vouchers (in pretix) are
17+
discount and sold at a lower price. They therefore reduce both revenue as well as taxes. Vouchers (in eventyay) are
1818
always specific to a certain product in an order. Vouchers are usually not sold but given out as part of a
19-
marketing campaign or to specific groups of people. Vouchers in pretix are bound to a specific event.
19+
marketing campaign or to specific groups of people. Vouchers in eventyay are bound to a specific event.
2020

2121
* Gift cards are not a discount, but rather a means of payment. If you buy a €20 ticket with a €10 gift card, it is
2222
still a €20 ticket and will still count towards your revenue with €20. Gift cards are usually bought for the money
23-
that they are worth. Gift cards in pretix can be used across events (and even organizers).
23+
that they are worth. Gift cards in eventyay can be used across events (and even organizers).
2424

2525
Selling gift cards
2626
------------------
2727

28-
Selling gift cards works like selling every other type of product in pretix: Create a new product, then head to
28+
Selling gift cards works like selling every other type of product in eventyay: Create a new product, then head to
2929
"Additional settings" and select the option "This product is a gift card". Whenever someone buys this product and
3030
pays for it, a new gift card will be created.
3131

3232
In this case, the gift card code corresponds to the "ticket secret" in the PDF ticket. Therefore, if selling gift cards,
3333
you can use ticket downloads just as with normal tickets and use our ticket editor to create beautiful gift certificates
3434
people can give to their loved ones.
3535

36-
Of course, you can use pretix' flexible options to modify your product. For example, you can configure that the customer
36+
Of course, you can use eventyay' flexible options to modify your product. For example, you can configure that the customer
3737
can freely choose the price of the gift card.
3838

3939
.. note::
4040

41-
pretix currently does not support charging sales tax or VAT when selling gift cards, but instead charges VAT on
41+
eventyay currently does not support charging sales tax or VAT when selling gift cards, but instead charges VAT on
4242
the full price when the gift card is redeemed. This is the correct behavior in Germany and some other countries for
4343
gift cards which are not bound to a very specific service ("Warengutschein"), but instead to a monetary amount
4444
("Wertgutschein").
@@ -69,5 +69,5 @@ Manually issuing or using gift cards
6969
------------------------------------
7070

7171
Of course, you can also issue or redeem gift cards manually through our backend using the "Gift cards" menu item in your
72-
organizer profile or using our API. These gift cards will be tracked by pretix, but do not correspond to any purchase
73-
within pretix. You will therefore need to account for them in your books separately.
72+
organizer profile or using our API. These gift cards will be tracked by eventyay, but do not correspond to any purchase
73+
within eventyay. You will therefore need to account for them in your books separately.

doc/user/events/guides/timeslots.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
Use case: Time slots
44
====================
55

6-
A more advanced use case of pretix is using pretix for time-slot-based access to an area with a limited visitor
6+
A more advanced use case of eventyay is using eventyay for time-slot-based access to an area with a limited visitor
77
capacity, such as a museum or other attraction. This guide will show you the quickest way to set up such an event
8-
with pretix.
8+
with eventyay.
99

1010
First of all, when creating your event, you need to select that your event represents an "event series":
1111

@@ -14,7 +14,7 @@ First of all, when creating your event, you need to select that your event repre
1414
:align: center
1515
:class: screenshot
1616

17-
You can click :ref:`here <subevents>` for a more general description of event series with pretix, but everything you
17+
You can click :ref:`here <subevents>` for a more general description of event series with eventyay, but everything you
1818
need to know is in this chapter as well.
1919

2020
General event setup

doc/user/events/invoicing.rst

+9-9
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Invoice settings
33

44
.. spelling:: Inv
55

6-
The settings at "Settings" → "Invoice" allow you to specify if and how pretix should generate invoices for your orders.
6+
The settings at "Settings" → "Invoice" allow you to specify if and how eventyay should generate invoices for your orders.
77

88
.. thumbnail:: ../../screens/event/settings_invoice.png
99
:align: center
@@ -12,27 +12,27 @@ The settings at "Settings" → "Invoice" allow you to specify if and how pretix
1212
In particular, you can configure the following things:
1313

1414
Generate invoices
15-
This field controls whether pretix should generate an invoice for an order. You have the following options:
15+
This field controls whether eventyay should generate an invoice for an order. You have the following options:
1616

1717
No
18-
pretix will never generate an invoice. If you want to issue invoices, you need to do it yourself based on the
18+
eventyay will never generate an invoice. If you want to issue invoices, you need to do it yourself based on the
1919
collected address data.
2020

2121
Manually in admin panel
22-
pretix will not create invoices automatically, but the order detail view will show a button that allows you to
22+
eventyay will not create invoices automatically, but the order detail view will show a button that allows you to
2323
manually generate one for specific orders.
2424

2525
Automatically on user request
26-
pretix will not create invoices on its own, but both the panel as well as the customer view of the order will
26+
eventyay will not create invoices on its own, but both the panel as well as the customer view of the order will
2727
show a button that instantly generates an invoice for the specified order.
2828

2929
Automatically for all created orders
30-
pretix will automatically create an invoice every time an order is placed.
30+
eventyay will automatically create an invoice every time an order is placed.
3131

3232
Automatically on payment
33-
pretix will automatically create an invoice for an order, as soon as the payment for the order is received.
33+
eventyay will automatically create an invoice for an order, as soon as the payment for the order is received.
3434

35-
pretix will never generate invoices for free orders, even though it might ask for the invoice address.
35+
eventyay will never generate invoices for free orders, even though it might ask for the invoice address.
3636

3737
Attach invoices to emails
3838
If enabled, invoices will be attached to order confirmation e-mails if the "Generate invoices" setting is set to
@@ -100,7 +100,7 @@ Your invoice details
100100
the header of the invoice.
101101

102102
Invoice style
103-
This setting allows you to choose the design of your invoice. Additional designs can be added by pretix plugins.
103+
This setting allows you to choose the design of your invoice. Additional designs can be added by eventyay plugins.
104104

105105
Introductory text
106106
A free custom text that will be printed above the list of products on the invoice.

doc/user/events/plugins.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
Configuring plugins
22
===================
33

4-
Plugins are optional parts of pretix that can be installed to extend the available functionality and that can be turned
4+
Plugins are optional parts of eventyay that can be installed to extend the available functionality and that can be turned
55
on or off completely for every event. For your event, a number of plugins might be active already, but you can unlock
66
even more functionality by going to "Settings" → "Plugins" and enable more of them, if you need.
77

88
.. thumbnail:: ../../screens/event/settings_plugins.png
99
:align: center
1010
:class: screenshot
1111

12-
For each plugin, you will find a short description as well as an Enable/Disable button. The pretix website has
12+
For each plugin, you will find a short description as well as an Enable/Disable button. The eventyay website has
1313
`an overview`_ of available plugins and more details of them. If you are on the eventyay.com hosted service, look for
14-
the "pretix Hosted" badge in the plugin list to learn which ones are supported there.
14+
the "eventyay Hosted" badge in the plugin list to learn which ones are supported there.
1515

16-
If you are running pretix on your own server, refer to the installation manual of your installation type to learn
16+
If you are running eventyay on your own server, refer to the installation manual of your installation type to learn
1717
how to install additional plugins (:ref:`manual <manual_plugininstall>` or :ref:`Docker <docker_plugininstall>`).
1818

1919
.. _an overview: https://eventyay.com/about/en/plugins

0 commit comments

Comments
 (0)