From bead70b43ace5a7d51be18eef174f4321a91dcc1 Mon Sep 17 00:00:00 2001 From: Rushabh Mehta Date: Fri, 28 Jul 2017 11:44:08 +0530 Subject: [PATCH] Docs in website (#10149) * [docs] move to erpnext.org * [docs] * [minor] add title --- README.md | 3 +-- erpnext/change_log/v6/v6_13_1.md | 2 +- erpnext/change_log/v6/v6_2_0.md | 2 +- erpnext/config/docs.py | 19 +++++++++++++------ .../making-custom-reports-in-erpnext.md | 4 ++-- .../en/customize-erpnext/customize-form.md | 2 +- .../getting-started-with-erpnext.md | 4 ++++ .../docs/user/manual/en/selling/quotation.md | 2 +- ...egrating-erpnext-with-other-application.md | 2 +- .../welcome_to_erpnext.html | 2 +- .../announcement/announcement_row.html | 6 +++--- 11 files changed, 29 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 1fae1ce2ea..b44a246bb1 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,7 @@ Includes: Accounting, Inventory, Manufacturing, CRM, Sales, Purchase, Project Ma ERPNext is built on the [Frappe](https://github.com/frappe/frappe) Framework, a full-stack web app framework in Python & JavaScript. -- [User Guide](https://frappe.github.io/erpnext/) -- [Getting Help](http://erpnext.org/getting-help.html) +- [User Guide](https://erpnext.org/docs/user) - [Discussion Forum](https://discuss.erpnext.com/) --- diff --git a/erpnext/change_log/v6/v6_13_1.md b/erpnext/change_log/v6/v6_13_1.md index 1f0a5684d1..4b2c4a9cca 100644 --- a/erpnext/change_log/v6/v6_13_1.md +++ b/erpnext/change_log/v6/v6_13_1.md @@ -1 +1 @@ -- [ERPNext Manual in German](http://frappe.github.io/erpnext/user/manual/de/) contributed by [CWT Connector & Wire Technology GmbH](http://www.cwt-assembly.com/) +- [ERPNext Manual in German](http://erpnext.org/docs/user/manual/de/) contributed by [CWT Connector & Wire Technology GmbH](http://www.cwt-assembly.com/) diff --git a/erpnext/change_log/v6/v6_2_0.md b/erpnext/change_log/v6/v6_2_0.md index 004e90caa4..f4da651c7b 100644 --- a/erpnext/change_log/v6/v6_2_0.md +++ b/erpnext/change_log/v6/v6_2_0.md @@ -1 +1 @@ -- **[Multi-currency Accounting](https://frappe.github.io/erpnext/user/guides/accounts/multi-currency-accounting)**: You can now have an Account in a different currency than your Company's currency +- **[Multi-currency Accounting](https://frappe.io/docs/user/guides/accounts/multi-currency-accounting)**: You can now have an Account in a different currency than your Company's currency diff --git a/erpnext/config/docs.py b/erpnext/config/docs.py index 2d2cc0a892..7c91455a0e 100644 --- a/erpnext/config/docs.py +++ b/erpnext/config/docs.py @@ -1,12 +1,11 @@ from __future__ import unicode_literals -docs_version = "7.x.x" - source_link = "https://github.com/frappe/erpnext" docs_base_url = "https://frappe.github.io/erpnext" -headline = "ERPNext Documentation" -sub_heading = "Detailed explanation for all ERPNext features and developer API" -long_description = """ERPNext is a fully featured ERP system designed for Small and Medium Sized +headline = "ERP Made Simple" +sub_heading = "ERPNext User Guides and API References" +long_description = """ +ERPNext is a fully featured ERP system designed for Small and Medium Sized business. ERPNext covers a wide range of features including Accounting, CRM, Inventory management, Selling, Purchasing, Manufacturing, Projects, HR & Payroll, Website, E-Commerce and much more. @@ -17,7 +16,15 @@ to extend ERPNext functionality. ERPNext is Open Source under the GNU General Public Licence v3 and has been listed as one of the Best Open Source Softwares in the world by many online -blogs.""" +blogs. + +### Getting Started + +To install ERPNext on a server, you will need to install [Frappe Bench](https://github.com/frappe/bench). + +You can also start a free 30 day trial at [https://erpnext.com](https://erpnext.com) + +""" splash_light_background = True google_analytics_id = 'UA-8911157-22' diff --git a/erpnext/docs/user/manual/en/customize-erpnext/articles/making-custom-reports-in-erpnext.md b/erpnext/docs/user/manual/en/customize-erpnext/articles/making-custom-reports-in-erpnext.md index 7bc965b656..3d5174fcde 100644 --- a/erpnext/docs/user/manual/en/customize-erpnext/articles/making-custom-reports-in-erpnext.md +++ b/erpnext/docs/user/manual/en/customize-erpnext/articles/making-custom-reports-in-erpnext.md @@ -12,12 +12,12 @@ Report Builder is an in-built report customization tool in ERPNext. This allows Query Report is written in SQL which pull values from account's database and fetch in the report. Though SQL queries can be written from front end, like HTML, its restricted in hosted users. Because it will allow users with no access to specific report to query data directly from the database. -Check Purchase Order Item to be Received report in Stock module for example of Query report. Click [here](https://frappe.github.io/frappe/user/en/guides/reports-and-printing/how-to-make-query-report.html) to learn how to create Query Report. +Check Purchase Order Item to be Received report in Stock module for example of Query report. Click [here](https://frappe.io/docs/user/en/guides/reports-and-printing/how-to-make-query-report.html) to learn how to create Query Report. ### 3. Script Report Script Reports are written in Python and stored on server side. These are complex reports which involves logic and calculation. Since these reports are written on server side, customizing it from hosted account is not possible. -Check Financial Analytics report in Accounts module for example of Script Report. Click [here](https://frappe.github.io/frappe/user/en/guides/reports-and-printing/how-to-make-script-reports.html) to learn how to create Script Report. +Check Financial Analytics report in Accounts module for example of Script Report. Click [here](https://frappe.io/docs/user/en/guides/reports-and-printing/how-to-make-script-reports.html) to learn how to create Script Report. \ No newline at end of file diff --git a/erpnext/docs/user/manual/en/customize-erpnext/customize-form.md b/erpnext/docs/user/manual/en/customize-erpnext/customize-form.md index f52cee1aab..dd14a431db 100644 --- a/erpnext/docs/user/manual/en/customize-erpnext/customize-form.md +++ b/erpnext/docs/user/manual/en/customize-erpnext/customize-form.md @@ -1,5 +1,5 @@ -Before we venture to learn form customization tool, click [here](https://frappe.github.io/frappe/user/en/tutorial/doctypes.html) to understand the architecture of forms in ERPNext. It shall help you in using Customize Form tool more efficiently. +Before we venture to learn form customization tool, click [here](https://frappe.io/docs/user/en/tutorial/doctypes.html) to understand the architecture of forms in ERPNext. It shall help you in using Customize Form tool more efficiently. Customize Form is the tool which allows user to customize property of the standard fields, and insert [custom fields]({{docs_base_url}}/user/manual/en/customize-erpnext/custom-field.html) as per the requirement. Let's assume we need to set Project Name field as a mandatory field in the Sales Order form. Following are the steps which shall be followed to achieve this. diff --git a/erpnext/docs/user/manual/en/introduction/getting-started-with-erpnext.md b/erpnext/docs/user/manual/en/introduction/getting-started-with-erpnext.md index 7e783f679b..2f59eb4e53 100644 --- a/erpnext/docs/user/manual/en/introduction/getting-started-with-erpnext.md +++ b/erpnext/docs/user/manual/en/introduction/getting-started-with-erpnext.md @@ -1,3 +1,7 @@ + + +# Getting Started with ERPNext + There are many ways to get started with ERPNext. ### 1\. See the Demo diff --git a/erpnext/docs/user/manual/en/selling/quotation.md b/erpnext/docs/user/manual/en/selling/quotation.md index 1f7b06c45e..324a6661f0 100644 --- a/erpnext/docs/user/manual/en/selling/quotation.md +++ b/erpnext/docs/user/manual/en/selling/quotation.md @@ -83,6 +83,6 @@ Print Heading. While making your sales transactions like a Quotation (or Sales Order) you can also give discounts to your customers. In the Discount section, add -the discount in percentage or fixed amount. Read [Discount](https://frappe.github.io/erpnext/user/manual/en/selling/articles/applying-discount) for more explanation. +the discount in percentage or fixed amount. Read [Discount](https://erpnext.org/docs/user/manual/en/selling/articles/applying-discount) for more explanation. {next} diff --git a/erpnext/docs/user/manual/en/setting-up/articles/integrating-erpnext-with-other-application.md b/erpnext/docs/user/manual/en/setting-up/articles/integrating-erpnext-with-other-application.md index 3cbf159c2f..7ab6849898 100644 --- a/erpnext/docs/user/manual/en/setting-up/articles/integrating-erpnext-with-other-application.md +++ b/erpnext/docs/user/manual/en/setting-up/articles/integrating-erpnext-with-other-application.md @@ -2,6 +2,6 @@ For now, ERPNext has out-of-the-box integration available for some applications like Shopify, your SMS gateway and payment gateway. To integrate ERPNext with other application, you can use REST API of Frappe. Check following links to learn more about REST API of Frappe. -[Frappe Rest API](https://frappe.github.io/frappe/user/en/guides/integration/rest_api.html) +[Frappe Rest API](https://frappe.io/docs/user/en/guides/integration/rest_api.html) \ No newline at end of file diff --git a/erpnext/setup/page/welcome_to_erpnext/welcome_to_erpnext.html b/erpnext/setup/page/welcome_to_erpnext/welcome_to_erpnext.html index cd4d9771c4..57fce28eeb 100644 --- a/erpnext/setup/page/welcome_to_erpnext/welcome_to_erpnext.html +++ b/erpnext/setup/page/welcome_to_erpnext/welcome_to_erpnext.html @@ -22,7 +22,7 @@ diff --git a/erpnext/templates/includes/announcement/announcement_row.html b/erpnext/templates/includes/announcement/announcement_row.html index d807bfc530..3099441e34 100644 --- a/erpnext/templates/includes/announcement/announcement_row.html +++ b/erpnext/templates/includes/announcement/announcement_row.html @@ -3,12 +3,12 @@
-

{{ doc.subject }}

+

{{ doc.subject }}

{{ doc.description }}

{{ doc.posted_by }} - {{ frappe.format_date(doc.modified) }} - {{ doc.num_attachments }} attachments + {{ frappe.format_date(doc.modified) }} + {{ doc.num_attachments }} attachments