How to contribute ERPNext documentation[WIP]

1. What is the goal of this tutorial?

Add the sentence “Prepare your Balance Sheet and Profit and Loss Statement” to official ERPNext documentation.

Login to your ERPNext account and open the Documentation.

In “Introduction” page you will see a list of things which ERPNext helps you do.

ERPNext helps you prepare your Balance Sheet and Profit and Loss Statement, lets add this to the list.

2. Any Pre-requisites?

Frappe development environment in your local machine.

Please find below the links to guides on how to setup Frappe development environment.

• The Hitchhiker's Guide to Installing Frappé on Mac OS X
• The Hitchhiker's Guide to Installing Frappé on Linux OS

3. Documentation is written in plain text, right?

Its not plain text, its not code, its text written in a particular style called Markdown.

4. Where does the documentation come from?

There is a folder called “docs” in your bench folder and all the documentation is stored in this folder.

For example all the text on introduction page come from this file.

frappe-bench/apps/erpnext/erpnext/docs/user/manual/en/introduction/index.md

5. How to update documentation?

Goto frappe-bench/apps/erpnext folder and create a new branch using below command

git checkout -b [Your branch name]

Example:

git checkout -b erpnext_documentation_introduction

Open the index.md file under introduction folder with your favourite editor.

Insert “* Prepare your Balance Sheet and Profit and Loss Statement” after “ * Publish your website.” line.

Save the file, refresh your browser and open documentation and you can see that it has been updated.

If needed, change/add/remove further.

Once you are done run below command

git commit -a -m "[Documentation only] Updated introduction"

6. How to push changes to GitHub?

Fork ERPNext repo and push your local changes to your repo

7. How to update official ERPNext documentation?

Create a pull request

8. That is it?

Now your pull request will either be merged or you will get feedback on what needs to be changed.

9. Am I a contributor now?

Yes you are! Celebrate!!

10. Who owns the documentation?

ERPNext Community! Specifically ERPNext Foundation owns all such assets.

Would you like to see more such tutorials? Send a pull request!