Browse Source

Add VCS documentation (#3580)

* Add VCS documentation
Matthew 5 years ago
parent
commit
053e93565e

BIN
getting_started/workflow/project_setup/img/version_control_menu.png


+ 1 - 1
getting_started/workflow/project_setup/index.rst

@@ -6,6 +6,6 @@ Project setup
    :name: toc-learn-workflow-project_setup
 
    project_organization
+   version_control_systems
 
 .. plugins_from_assetlib
-.. cvs

+ 33 - 0
getting_started/workflow/project_setup/version_control_systems.rst

@@ -0,0 +1,33 @@
+.. _doc_version_control_systems:
+
+Version Control Systems
+=======================
+
+Introduction
+------------
+
+Godot aims to be VCS friendly and generate mostly readable and
+mergeable files. Godot also supports the use of version control
+systems in the editor itself. However, VCS in the editor requires
+a plugin for the specific VCS you are using. VCS can be setup or
+shut down in the editor under Project > Version Control.
+
+.. image:: img/version_control_menu.png
+
+Official Git plugin
+-------------------
+
+Using Git from inside the editor is supported with an official plugin. You can find the latest
+releases `here <https://github.com/godotengine/godot-git-plugin/releases>`_ 
+(it is not available in the asset library). Documentation on how
+to use the Git plugin can be found `here <https://github.com/godotengine/godot-git-plugin/wiki>`_.
+
+Files to exclude from VCS
+-------------------------
+
+There are some folders Godot creates you should have your VCS ignore:
+
+* .import (This folder stores all the files it imports automatically based on your source assets and their import flags.)
+* .translation (This folder stores imported translations generated from CSV files)
+* export_presets.cfg (This file contains all the export presets for the project)
+* .mono  (This folder stores automatically generated mono files, it only exists in projects that use the mono version of Godot)