Skip to content

Commit

Permalink
Merge pull request #8164 from turbo124/master
Browse files Browse the repository at this point in the history
Update docs
  • Loading branch information
turbo124 committed Jan 16, 2023
2 parents 1463544 + a75fd54 commit 7b82c79
Show file tree
Hide file tree
Showing 26 changed files with 78 additions and 0 deletions.
3 changes: 3 additions & 0 deletions app/Traits/GenerateMigrationResources.php
Original file line number Diff line number Diff line change
Expand Up @@ -1773,6 +1773,9 @@ private function getClientGatewayTokens()
'gateway_type_id' => $payment_method->payment_type->gateway_type_id,
'is_default' => $is_default,
'meta' => $this->convertMeta($payment_method),
'created_at' => $payment_method->created_at ? Carbon::parse($payment_method->created_at)->toDateString() : null,
'updated_at' => $payment_method->updated_at ? Carbon::parse($payment_method->updated_at)->toDateString() : null,
'deleted_at' => $payment_method->deleted_at ? Carbon::parse($payment_method->deleted_at)->toDateString() : null,
];

$is_default = false;
Expand Down
3 changes: 3 additions & 0 deletions docs/client_portal.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Client Portal
=============

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The invoicing process is a two-way street. You bill the client; the client views and pays the invoice. Why not make it as easy as possible for you – and for your clients? This is the purpose of Invoice Ninja's Client Portal. With Invoice Ninja, you can choose to provide a portal for your clients where they can open and view your invoices, and even make payments, all via the Invoice Ninja website.

You can modify the Client Portal with a range of settings. To modify the client portal, go to Advanced Settings > Client Portal.
Expand Down
3 changes: 3 additions & 0 deletions docs/credits.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Credits
=======

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

List Credits
""""""""""""

Expand Down
3 changes: 3 additions & 0 deletions docs/custom_modules.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Custom Modules
==============

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Invoice Ninja support customs modules using https://github.com/nWidart/laravel-modules

You can watch this `short video <https://www.youtube.com/watch?v=8jJ-PYuq85k>`_ for a quick overview of the feature.
Expand Down
3 changes: 3 additions & 0 deletions docs/data_visualizations.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Data Visualizations
===================

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Who says analyzing your invoicing data can't be fun? Data Visualizations is an interactive, intuitive and practical feature that helps you understand exactly what is going on with your invoicing numbers. The visualization function takes your data, according to the data group you select, and creates a visual pattern that demonstrates your income proportions according to various parameters. What's more, it's not just a graphical display; it also links to the various data in the illustration, making it easy for you to dig deeper into your numbers, simply by hovering your mouse.

- **Group by**: To generate a Data Visualization, select the required data group (Clients, Invoices, Products). The visualization will be automatically generated below.
Expand Down
3 changes: 3 additions & 0 deletions docs/developer_guide.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Developer Guide
===============

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This guide will provide an overview of Invoice Ninja. If anything’s unclear please send us an email, we’re always working to improve it.

The application is written in PHP using the `Laravel <http://laravel.com/>`_ framework, the full list of libraries can be found on our `GitHub <https://github.com/invoiceninja/invoiceninja>`_ page.
Expand Down
3 changes: 3 additions & 0 deletions docs/digital_ocean.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Digital Ocean
===================

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Invoice Ninja has created a Digital Ocean Marketplace image with Invoice Ninja pre-installed.

To use this image, when creating a Droplet, choose **Marketplace** under the **Choose an image section**, and select the **Invoice Ninja on Ubuntu 18.04** image.
Expand Down
3 changes: 3 additions & 0 deletions docs/email_settings.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Email Settings
==============

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Email communication with your clients is an important part of the Invoice Ninja invoicing process – sending invoices via email, notifying clients that an invoice is due, reminding clients about overdue payments, and more.

With the Email Settings feature, you can specify certain settings and designs for the notification emails your clients receive from your Invoice Ninja account.
Expand Down
3 changes: 3 additions & 0 deletions docs/expenses.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Expenses
========

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Running a freelance business isn't just about the money that's coming in. You also need to take care of the money going out. With Invoice Ninja, all your earnings, expenses, clients and vendors are stored and managed in one, smart system designed to keep you on top of things. What's more, the Expenses part of your Invoice Ninja account streamlines with your invoicing via a click of the mouse, across multiples currencies, so you get the complete bigger picture of your business expenses - with simplicity and ease.

List Expenses
Expand Down
3 changes: 3 additions & 0 deletions docs/install.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Install
=======

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Thanks for taking the time to setup Invoice Ninja.

.. Note:: The applications requires PHP 7.1 or 7.2 and MySQL.
Expand Down
3 changes: 3 additions & 0 deletions docs/introduction.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Introduction
============

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Let’s get acquainted with a basic overview of the structure of the Invoice Ninja website. Once you’ve wrapped your mind around a few central concepts, it’s as easy as ABC to effectively manage your freelance business accounts.

The Invoice Ninja system is based on two main pillars:
Expand Down
3 changes: 3 additions & 0 deletions docs/invoice_design.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Invoice Design
==============

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Whether you're a design novice or programming pro, Invoice Ninja gives you the power to customize your invoice design, to give your invoices the exact look you want. The design tool is the perfect way to match your invoices to your company's graphical look and feel, including colors, fonts, logos, margin sizes, column names, headers, footers and much more.

You can design you invoice using the simple selection tools, or go deeper and customize it from the foundations with our customization feature.
Expand Down
3 changes: 3 additions & 0 deletions docs/invoice_settings.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Invoice Settings
================

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You can customize your invoice template by pre-defining the various numbering formats, adding new fields for client, contact, company or invoice information, and adding default text to invoice terms, invoice footer, and more. Any changes you make to the Invoice Settings will apply to all your invoices.

The Invoice Settings page has four sections:
Expand Down
3 changes: 3 additions & 0 deletions docs/invoices.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Invoices
========

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Well, it’s time to bill, and the Invoices function of Invoice Ninja lets you get the job done fast and with perfect accuracy.

With a bustling freelance business, you’re going to be sending out a lot of invoices. Creating an invoice is simple with the New Invoice page. Once you’ve entered the client, job and rates information, you’ll see a live PDF preview of your invoice, and you’ll have a range of actions at your fingertips – from saving a draft, to sending the invoice to the client via email, to printing a PDF hard copy.
Expand Down
3 changes: 3 additions & 0 deletions docs/mobile_apps.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Mobile Applications
===================

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The Invoice Ninja iPhone and Android applications allows a user to connect to their self-hosted Invoice Ninja web application.

.. TIP:: If you're unable to access the Android app store you can download the APK here: https://download.invoiceninja.com/apk
Expand Down
3 changes: 3 additions & 0 deletions docs/payments.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Payments
========

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The Invoice Ninja system handles your entire invoicing process – from sending a quote (Pro Plan only), to invoicing your client, to receiving payment. What’s more, you can receive payments directly and automatically via Invoice Ninja’s 45+ payment partners, enabling totally smooth management of your customer accounts using your choice of payment provider. To learn more about Invoice Ninja’s payment partners, `click here <https://www.invoiceninja.com/partners>`_.

List Payments
Expand Down
3 changes: 3 additions & 0 deletions docs/proposals.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Proposals
=========

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

When submitting a regular quote is not enough, the advanced Proposals feature comes to the rescue.

Proposals are a powerful sales and marketing tool to present your offer for a gig. Whether you're competing against other providers, or you want to make a fantastic impression, the proposal function is a great way to custom-create a personalized proposal containing all the information you need to convey.
Expand Down
3 changes: 3 additions & 0 deletions docs/quotes.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Quotes
======

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

For Pro Plan users, the Quotes function streamlines your invoicing activity, from the moment you create and send a price quote for a particular job, until the quote is accepted, you invoice the job, receive payment and provide a receipt. With the Quotes function, you can automatically convert accepted quotes into invoices in a swift one-click action. Keeping track of your projected work schedule and potential income, the Quotes feature gives you even greater control of your freelance activity.

List Quotes
Expand Down
3 changes: 3 additions & 0 deletions docs/recurring_invoices.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Recurring Invoices
==================

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

As a busy freelancer, you work for a variety of clients. Some jobs are one-off, but others are ongoing, whether on a weekly, monthly or other basis. Invoice Ninja’s Recurring Invoice feature automatically creates invoices for ongoing jobs, and sends the current invoice to the client on a regular, pre-defined basis. For each recurring job, you only need to set up the procedure once. Here’s how it works.

List Recurring Invoices
Expand Down
3 changes: 3 additions & 0 deletions docs/reports.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Reports
=======

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

It's easy to get caught up in the job you are currently working on, sending invoices and chasing payments. But it's just as important to take a step back from time to time, and to look at the bigger picture of how your freelance business is doing.

The Reports function helps you do just that. You can define your parameters and extract the exact information you need to generate a range of reports.
Expand Down
3 changes: 3 additions & 0 deletions docs/settings.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Settings
========

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Intro
"""""

Expand Down
3 changes: 3 additions & 0 deletions docs/tasks.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Tasks
=====

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Got lots of tasks running at the same time? Projects to invoice? Returning to work on that particular job from last month? The Tasks feature keeps all of these details in order, so you can best manage your time, your projects and your clients’ needs.

List Tasks
Expand Down
3 changes: 3 additions & 0 deletions docs/templates_and_reminders.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Templates & Reminders
=====================

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

There are a few different emails your customers receive from you via the Invoice Ninja system as part of your invoicing communications. These include the invoice notification email, quote notification email, payment notification email and various reminder emails. You can customize all your emails by selecting a template, text and design, and by specifying the frequency of reminder emails.

Email Templates
Expand Down
3 changes: 3 additions & 0 deletions docs/update.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Update
======

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. NOTE:: Note: v5 is now in beta. To upgrade from v4 you need to `install v5 <https://invoiceninja.github.io/docs/self-host-installation/>`_ as a separate app and then use the migration tool in the latest version of v4 on Settings > Account Management.

To update the app you just need to copy over the latest code. Do not be afraid to overwrite the files, the configuration file for connections such as mysql are stored in the .env file. The app tracks the current version in a file called version.txt, if it notices a change it loads ``/update`` to run the database migrations.
Expand Down
3 changes: 3 additions & 0 deletions docs/user_management.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
User Management
===============

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Need help managing your invoicing? As an Invoice Ninja account owner, you can add as many users as you like to your account. Once added, users receive the status of 'Admin'. Your Admins have access to most areas and functions of your Invoice Ninja account.

The User Management page displays a table that includes all current users, with the following data columns:
Expand Down
3 changes: 3 additions & 0 deletions docs/vendors.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Vendors
=======

For Version 5.x documentation, please go to `invoiceninja.github.io <https://invoiceninja.github.io/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Running a business is a two way street. Sure, you serve clients and charge them for it. But you also use suppliers, companies and service providers who charge you for all the things you need to get your job done. Office supplies? Check. Coffee machine? Check. Gas for the car? Check. And a hundred-and-one other supplies and services you can name.

Your expenses and vendors are managed with the same ease and one-click functionality as every other part of your business, right here in your Invoice Ninja account. With Invoice Ninja, managing your vendors and expenses is simple – and similar – to managing your clients and invoices. It's only a matter of which way the money's going...
Expand Down

0 comments on commit 7b82c79

Please sign in to comment.