Merge pull request #180 from AryanNanda17/docs_contributors_guide

Contributors guided added to docs

Author: kubeedge-bot

docs/Makefile

@@ -30,4 +30,7 @@ api:
 html:
 	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
+livehtml:
+	sphinx-autobuild $(SOURCEDIR) $(BUILDDIR)/html
+	
 all: clean api html

docs/conf.py

@@ -29,6 +29,11 @@
     import sphinx_rtd_theme
 except ModuleNotFoundError:
     subprocess.check_call([sys.executable, "-m", "pip", "install", "sphinx_rtd_theme"])
+try:
+    import sphinx_autobuild
+except ModuleNotFoundError:
+    subprocess.check_call([sys.executable, "-m", "pip", "install", "sphinx-autobuild"])
+
 _base_path = os.path.abspath('..')
 BASE_URL = 'https://github.com/kubeedge/ianvs/'
 

docs/guides/how-to-contribute-documentation.md

@@ -0,0 +1,36 @@
+# How to contribute documentation
+
+**First off, thanks for taking the time to think about contributing!**
+
+The KubeEdge community abides by the CNCF [code of conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). Here is an excerpt:
+
+_As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities._
+
+---
+For Contributing to the ianvs documentation hosted at `https://ianvs.readthedocs.io/en/latest`, follow the following instructions:- 
+
+### Forking the project
+
+You can [fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) this project repository to create and submit changes to the documentation.
+
+Then, open the terminal of your choice and run the following command to clone the forked project to your computer. The project is saved to the location where the terminal is opened from. If you want to change the location, use `cd` command to change the directory.
+
+```shell
+git clone <your forked repository link>
+```
+Wait until all of the project files are downloaded. A folder with the name `ianvs` will be created. You need to enter into the directory with the `cd` command.
+
+**Note: In order to build ianvs documentation on your local machine you need a python version 3.6**.
+
+- Now, execute these commands in your terminal 
+```
+cd docs
+python3 conf.py # downloads the requirements
+```
+Now, build and serve it live using sphinx-autobuild,
+
+```
+make livehtml
+```
+
+Now, you can open http://127.0.0.1:8000 on any browser to see the rendered HTML with live updates. Clear cookies and site data in your browser window to view up to date site.

docs/index.rst

@@ -90,7 +90,7 @@ Start your journey on Ianvs with the following links:
     guides/how-to-contribute-test-environments
     guides/how-to-contribute-algorithms
     guides/how-to-contribute-leaderboards-or-test-reports
-
+    guides/how-to-contribute-documentation
 
 .. toctree::
     :maxdepth: 1