From 7b7805e48590bb1b339af78935513bf86b01dcef Mon Sep 17 00:00:00 2001 From: Kenneth Sequeira <33246109+kennethsequeira@users.noreply.github.com> Date: Mon, 3 Sep 2018 17:17:36 +0530 Subject: [PATCH] Created How To Contribute to ERPNext Documentation (markdown) --- How-To-Contribute-to-ERPNext-Documentation.md | 69 +++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 How-To-Contribute-to-ERPNext-Documentation.md diff --git a/How-To-Contribute-to-ERPNext-Documentation.md b/How-To-Contribute-to-ERPNext-Documentation.md new file mode 100644 index 0000000..6d930ef --- /dev/null +++ b/How-To-Contribute-to-ERPNext-Documentation.md @@ -0,0 +1,69 @@ +

+This is a short guide outlining the steps for contributing to the ERPNext documentation. The docs can be contributed by anyone, not just developers.

+ +

Note: Before starting to begin writing/editing/fixing the docs, you must have a little background in the following technologies:

+ +1. Frappe + +

Just like ERPNext, the foundation website is a Frappe app. We will be installing the app just like ERPNext on a bench site. This will be used to visually review the changes made to the docs.

+ +

In case of a Mac or Linux OS, you can setup Frappe on your laptop/PC by following these guides. In case of a Windows machine, you can use a VM to install Frappe. +

+ +2. Git + +

Frappe/ERPNext, uses Git for revision control. You can learn the basics by referring to a multitude of free online tutorials. You can also brush up your skills on https://try.github.io/

+ +

The source code of ERPNext is hosted on GitHub, a hosting service using the Git SCM. Some other popular hosting services are Bitbucket, and Gitlab. You can signup [here](https://github.com/join) and create an account for free.

+ +3. Markdown + +

Markdown is a lightweight markup language (like HTML) which is converted to structurally valid HTML when you see a webpage. Markup lets you format the text much faster than HTML by avoiding the tags and using special symbols for the same. Some parts of this wiki are written in the same way!

+ +

Learning markdown is pretty easy and you may have used it unknowingly when formatting messages on Whatsapp or on the forum. +

+ +4. Creating your own fork of the foundation application + +

Getting into jargon, think of a fork as your copy of the application. The fork will be created on your GitHub profile/account just like mine is. This will be referred to as your fork or remote from hereafter.

+ +

Okay, now since we're pretty much done with the pre-requisites, let's start contributing some docs!

+ +

+ +## Editing Docs on GitHub + +

This method is to be used strictly in the case of editing the text of a paricular page like say, adding more sentences or paragraph, fixing spelling mistakes, fixing the link of an image or webpage, add missing link in the index etc.

+ +

This cannot be used when you need to add a new page or a new image.

+ + 1. Locate the page to be edited + +

You can do this by simply clicking on the link saying Improve this page +

+ +

+ ERPNext Documentation +

+ + 2. Edit the page + +

After clicking the link, you will be taken to the specific page on GitHub which you can edit by clicking on the Pencil icon:

+ +

+ ERPNext Documentation +

+ +

+ ERPNext Documentation +

+ +

Once the changes have been made, click on the green button at the very bottom saying Propose File Change and raise a pull request. + +

+ height="150" alt="ERPNext Documentation"/> +

+ +

And there you go. You have raised a pull request to make changes to the documentation! + +> Contributed by [Kenneth Sequeira](https://github.com/kennethsequeira) <kenneth@frappe.io> \ No newline at end of file