Merge branch 'v5-rework' of https://github.com/invoiceninja/invoiceni…

…nja.github.io into v5-rework

lang/en/texts.php

@@ -131,5 +131,5 @@
     'activate' => 'Activate',
     'quick_search' => 'Quick search ...',
     'taxes' => 'Taxes',
-
+    'email_customization' => 'Email Customization',
 ];

lang/fr_CA/texts.php

@@ -92,5 +92,5 @@
     'stripe_integration' => 'Intégration Stripe',
     'quick_search' => 'Recherche rapide',
     'taxes' => 'Taxes',
-
+    'email_customization' => 'Email Customization',
 ];

source/en/advanced-settings.md

@@ -14,7 +14,7 @@ These settings govern customization of the standard document design and layout u
 
 #### Customize & Preview
 
-This button takes you to a very advanced template code editor, with a live preview generator.  Instructions for these features can be found under <a href="https://invoiceninja.github.io/docs/custom-fields/">under PDF Customizations</a>.  You can preview the invoice design templates here, before selecting one you like to use permanently.
+This button takes you to a very advanced template code editor, with a live preview generator.  Instructions for these features can be found under <a href="https://invoiceninja.github.io/en/custom-fields/">under PDF Customizations</a>.  You can preview the invoice design templates here, before selecting one you like to use permanently.
 
 #### Template Settings
 

source/en/credits.md

@@ -10,7 +10,7 @@ A credit note is a document sent to the client, notifying that a credit has been
 Credit notes are used to issue redeemable credits for a specific *Product* or for a flat rate.
 Credits can be applied to invoices as a payment.
 
-Note that choosing the right Payment Settings is vital to make credits intuitive and useful to your customers, see https://invoiceninja.github.io/docs/basic-settings/#payment_settings.
+Note that choosing the right Payment Settings is vital to make credits intuitive and useful to your customers, see https://invoiceninja.github.io/en/basic-settings/#payment_settings.
 
 ## Viewing a Credit
 

source/en/email-customization.md

@@ -0,0 +1,184 @@
+---
+extends: _layouts.user_guide 
+section: content
+locale: en
+---
+
+# Email Customization
+
+## Custom Content
+
+Customizing the content of you emails should be simple and painfree! By default we include a range of default - translated - templates which should suit most use cases! If you prefer to extend and customize the emails your clients please read on!
+
+## WYSIWYG Edior
+![alt text](/assets/images/reminders_templates/template_editor.png "Email content editor")
+
+To start editing and customizing your emails navigate to:
+
+```bash
+Settings > Templates & Reminmders
+```
+
+From here you'll see the first panel with a dropdown selector where you can select each of your email templates. In Invoice Ninja there are templates for Invoices, Quotes, Credits, Statements, Reminders, Purchase Orders and also up to 3 custom templates where you can curate your own templates.
+Selecting a template will replace the content in the panel beneath it where it can be updated and saved.
+
+## Invoice Email Customization
+
+The custom fields available for Invoices / Quotes and Credits are the same ones used for PDF customization, the full list can be found [here](http://localhost:8002/en/custom-fields#custom-fields)
+
+## Payment Email Customization
+
+The following are a basic list of support $variables that are supported in a payment email:
+
+```bash
+$view_link - A plain html link to view the payment ie https://invoice.ninja/client/payment/123
+$viewLink - Alias of $view_link
+$paymentLink - Alias of $view_link
+$view_button - Creates a style html button with an embedded link to the client portal
+$viewButton - Alias of $viewButton
+$portalButton - A plain html link to the client portal login page
+$portal_url - The text string of the client portal login page
+$view_url - The text string of the payment link
+
+$signature - The company email signature
+$emailSignature - Alias of $signature
+
+$poNumber - The purchase order number for the invoice (if set)
+$client.balance - The outstanding client balance
+$outstanding - Alias of $client.balance
+$client_balance - Alias of $client.balance
+$paid_to_date - Total paid to date for the client
+
+$from - Label for the translated word "From"
+$to - Label for the translated word "To"
+
+$number - The payment number
+$payment.number - Alias of $number
+$entity - Label for the term "Payment"
+$payment.amount - The amount of the payment
+$amount - Alias of $payment.amount
+$payment.refunded - The total refunded for the payment
+$payment.date - The date of the payment
+$transaction_reference - The payment transaction reference
+$public_notes - The public notes of the Payment record
+$payment1 - Custom value 1 for payments
+$payment2 - Custom value 2 for payments
+$payment3 - Custom value 3 for payments
+$payment4 - Custom value 4 for payments
+
+$client 1 - Custom value 1 for the client connected to the payment
+$client 2 - Custom value 2 for the client connected to the payment
+$client 3 - Custom value 3 for the client connected to the payment
+$client 4 - Custom value 4 for the client connected to the payment
+
+$address1 - Address line 1 of the client
+$client.address1 - Alias of $address1
+$address2 - Address line 2 of the client
+$client.address2 - Alias of $address2
+$client_address - Full client address
+$id_number - ID Number of the client
+$client.id_number - Alias of $id_number
+$client.number - Number of the client
+$vat_number - VAT/TAX number of the client
+$client.vat_number - Alias of $vat_number
+$website - Web URL of the client
+$client.website - Alias of website
+$phone - Client phone
+$client.phone - Alias of phone
+$country - Client country name
+$client.country - Alias of $country
+$email - Primary contact email address
+$client.email - Alias of email
+$client_name - The client name
+$client.name - Alias of $client_name
+$client - Alias of $client_name
+$city_state_postal - City / Start / Postal code of the client
+$client.city_state_postal - Alias of $city_state_postal
+$postal_city_state - Postal code / City /State of the client
+$client.postal_city_state - Alias of $postal_city_state
+$postal_city - Postal Code / City of the client
+$client.postal_city - Alias of $postal_city
+
+```
+
+In Invoice Ninja version 5, as a single payment can be associated with multiple invoices, there are some special helper variables which enable outputting all of the invoice references these are as follows:
+
+```bash
+$invoices - A comma separate string of invoices and the payment amount received for example:
+```
+
+<x-info>
+Invoice #123 $5000.00, Invoice #124 $1000.00
+</x-info>
+
+```bash
+$invoice_references_subject - A custom subject line which includes all of the invoices and their amounts, ie:
+```
+
+<x-info>
+Invoice #123 $5000.00, Invoice #124 $1000.00
+</x-info>
+
+```bash
+$invoice_references - A custom body of text including detailed information of the invoices
+```
+
+<x-info>
+Invoice #123
+Amount $5000.00
+Balance $0
+
+--------
+
+Invoice #124
+Amount $1000.00
+Balance $500.00
+</x-info>
+
+```bash
+$invoice - A comma separate list of invoice numbers
+```
+<x-info>
+Invoice #123,124,125
+</x-info>
+
+```bash
+$invoices.amount - A formatted string of invoice amounts
+```
+
+<x-info>
+Invoice #123 $1000 Invoice #124 $2000.00
+</x-info>
+
+
+```bash
+$invoices.balance - A formatted string of invoice balances
+```
+
+<x-info>
+Invoice #123 $1000 Invoice #124 $2000.00
+</x-info>
+
+
+```bash
+$invoices.due_date - A formatted string of invoice due dates
+```
+
+<x-info>
+Invoice #123 2023/01/01 Invoice #124 2023/01/02
+</x-info>
+
+```bash
+$invoice_numbers - Comma separate raw string of invoice numbers
+```
+
+<x-info>
+123,124,125
+</x-info>
+
+```bash
+$status_logo - Shows a paid stamp on the email if the payment status is completed
+```
+
+The end
+<x-next url=/en/custom-fields>PDF customization</x-next>

source/en/env-variables.md

@@ -174,4 +174,4 @@ This is the default environment setting.
 ```
 WEBCRON_SECRET=secret
 ```
-If using the webcron feature, you'll want to set a password here to prevent unauthorized people accessing this URL
+If using the webcron feature, you'll want to set a password here to prevent unauthorized people accessing this URL                          

source/en/hosted-migration.md

@@ -28,7 +28,7 @@ The next screen will display all of your companies which are available for migra
 
 Once you have selected the companies to migrate click the continue button. This will automatically start the migration process. When it has completed, you will receive an email with your next steps.
 
-After completing the migration you will want to deactivate v4 to prevent it from sending emails / recurring invoices and activate v5. The full guide for activating can be found [here](https://invoiceninja.github.io/docs/hosted-activate/)
+After completing the migration you will want to deactivate v4 to prevent it from sending emails / recurring invoices and activate v5. The full guide for activating can be found [here](https://invoiceninja.github.io/en/hosted-activate/)
 
 <x-info>If you receive a migration failed error, please contact us via [email protected] and we can assist further.</x-info>
 

source/en/migration.md

@@ -9,7 +9,7 @@ locale: en
 ## Migrating to v5
 
 <x-info>
-If you are a Hosted Invoice Ninja you can skip all of these steps. Just log into your account, click on the Start Migration button in Settings > Account Management and we will take care of the rest. Once you are happy your data is across you can follow the steps in our [Activation](https://invoiceninja.github.io/docs/hosted-activate/) guide
+If you are a Hosted Invoice Ninja you can skip all of these steps. Just log into your account, click on the Start Migration button in Settings > Account Management and we will take care of the rest. Once you are happy your data is across you can follow the steps in our [Activation](https://invoiceninja.github.io/en/hosted-activate/) guide
 </x-info>
 
 <x-warning>
@@ -22,7 +22,7 @@ The first step needed to prepare to migrate your data across to your new v5 inst
 
 ## Installing v5.
 
-Installing v5 is covered in detail [here](/docs/self-host-installation) with resources to cover your needs for Docker / Shared Hosting or Ubuntu/Centos installations.
+Installing v5 is covered in detail [here](/en/self-host-installation) with resources to cover your needs for Docker / Shared Hosting or Ubuntu/Centos installations.
 
 An important detail with your v5 installation is that your initial user login is identical to your v4 installation.
 
@@ -144,6 +144,7 @@ If you are experiencing issues with the migration not running as expected please
 
 ```
 EXPANDED_LOGGING=true 
+```
 
 Then attempt the migration again and afterwards inspect the log file in storage/logs/invoiceninja.log
 
@@ -167,3 +168,69 @@ If you see this error it indicates that one of your users has already registered
 
 Migration from version 4 to version 5 is only allowed between accounts with the same e-mail address. This is requirement,
 and before starting the migration, make sure you are using the same e-mail address on both version 4 and version 5 for the user.
+
+## v4 Sunset.
+
+Version 4 of Invoice Ninja has now entered its Sunset phase. For users still on the v4 platform, you should start planning _now_ to migrate to v5. 
+
+Version 5 has a greater range of functionality and improvements and is actively maintained. We release security and feature releases on a very regular basis which ensures the platform operates as expected. 
+
+You can test drive the new version of Invoice Ninja [here](https://react.invoicing.co/demo) the look and feel of the application should be very similar to v4!
+
+If you have a custom design that you wish to have migrated, please email a PDF example to [email protected] and we'll create a design that matches this for you.
+
+If you have an API integration, you'll want to check our v5 api docs [here](https://api-docs.invoicing.co) as the spec is different to v4. If you have any specific integration queries, you can contact us via email, or using the forum / slack support channels.
+
+Please do not delay your migration, at some point, it will become necessary to start the forced migration of accounts over to v5, this could be less than ideal for some users, so please engage with us early so that the migration experience is as smooth as possible.
+
+<div style="position: relative; padding-bottom: 56.25%; height: 0;"><iframe src="https://www.loom.com/embed/47a707f1624d425da74ab2fe33057941?sid=a6367087-9411-4894-b836-7fb5a3352bf2" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
+
+## v4 - v5 Migration FAQ:
+
+### Will i lose any data?  
+No. The migration only takes a copy of your current v4 data and sends this to the new v5 platform.
+
+### Do you support all of the v4 Payment Gateways?
+We support _most_ of the v4 payment gateways, however there are several that we no longer support. The full supported list of v5 gateways are as follows:
+
+- Stripe
+- WePay
+- Paypal Express
+- Checkout.com
+- Authorize.net (auth.net)
+- Square
+- Mollie
+- GoCardless
+- Payfast
+- PayTrace
+- Razorpay
+- Forte
+- eway
+- Braintree
+
+### What about custom invoice designs?
+
+In v5 we use plain css/html to create invoice designs, v4 designs are therefore not compatible. We offer a free template design so that you can still use your custom design in v5. Simply forward an example PDF to us at [email protected] and we'll replicate this for you.
+
+### How long does the migration take? Is there any downtime.
+
+Depending on the size of your dataset the migration could take anywhere from 1 to 15 minutes. You will receive an email as soon as the migration completes with the next steps.
+
+<x-warning>
+Only start the migration once. If you have a very large account, you may see a timeout in your browser, this is safe to ignore. The migration will continue in the background.
+</x-warning>
+
+### Will existing invoice / quote links continue to work?
+
+Yes! Once you have migrated, you'll just need to activate v5 ( Settings > Account Management) This will trigger forwarding of all v4 links onto the v5 platform.
+
+### Do i need to configure my settings again after the migration?
+
+There are two settings which may need to be readjusted after the migration:
+
+1. If you are an enterprise customer and have multiple users, you'll need to reassign their permissions.
+2. Your user notifications will need to be reenabled in Settings > User Details > Notifications
+
+### I received an email stating that there was an existing migration? What does this mean.
+
+If you receive this email it means that some time in the past you have migrated your data to v5. If you have not yet started to use v5, you'll want to perform the migration again using the _force_ option. This will wipe the old v5 data and replace it with a fresh copy from v4.

source/en/payments.md

@@ -30,6 +30,10 @@ These are the fields are available when editing a payment to add detail for your
 
 ## Enter a Payment
 
+<div class="video_container">
+<iframe class="video" src="https://www.youtube.com/embed/anX9l3MF-Ws" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+</div>
+
 When manually entering a payment, all of the above fields apply, in addition to these below.
 
 * **Client** - You must specify the client the payment is coming from first.
@@ -38,6 +42,11 @@ When manually entering a payment, all of the above fields apply, in addition to
 * **Applied** - Appearing after selecting an invoice, the amount applied to the invoice, generated automatically.  Any overpayment by the client is applied to their client record for future invoices.
 * **Send Email** - Enabled by default, disable to skip sending the client an email notifying them of their payment.
 
+## Using credits as part of a payment.
+<div class="video_container">
+<iframe class="video" src="https://www.youtube.com/embed/74v04u4Ma1M" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+</div>
+
 ## Lifecycle of a Payment
 
 ### Unapplied

source/en/recurring-invoices.md

@@ -115,6 +115,6 @@ Keep in mind that **[MONTHYEAR|MONTHYEAR]** syntax will take care of **overlappi
 ```
 
 ### Translations
-As you can see [MONTHYEAR|MONTHYEAR] uses "to" between date ranges. This is not hard coded, but it builds itself based on [your localization settings](/docs/basic-settings/#localization).
+As you can see [MONTHYEAR|MONTHYEAR] uses "to" between date ranges. This is not hard coded, but it builds itself based on [your localization settings](/en/basic-settings/#localization).
 
 <x-next url=/en/reports>Reports</x-next>