Xfce Wiki

Sub domains
 

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
documentation:migrate-documentation [2010/11/11 09:24] – created mikedocumentation:migrate-documentation [2010/11/12 20:11] (current) – [Keep documentation in sync] mike
Line 1: Line 1:
 ~~NOTRANS~~ ~~NOTRANS~~
  
-====== Migrate documentation ======+====== Set up documentation ======
  
-To migrate existing documentation from your project you will need to create a branch inside the //xfce4-docs// repository. After that you need to remove it from your project and add a git submodule instead.+You can follow instructions bellow either to migrate existing documentation from your project, or to create a new documentation. In both cases you need to create a branch for your documentation inside the //xfce4-docs// repository. After that you need to update your project with a git submodule.
  
 ===== Xfce4-docs branch ===== ===== Xfce4-docs branch =====
Line 31: Line 31:
     * ''<nowiki>git push</nowiki>''     * ''<nowiki>git push</nowiki>''
  
-By now when a user clones the repository, the content of the submodule will automatically be initialized by running the ''autogen.sh'' script. A check within ''xdt-autogen'' will make sure to run the command ''<nowiki>git submodule update --init doc</nowiki>''.+By now when a user clones the repository, the content of the submodule will automatically be initialized by running the ''autogen.sh'' script. A check within ''xdt-autogen'' will make sure to run the command ''<nowiki>git submodule update --init doc</nowiki>'' and pull the submodule.
  
-  * FIXME How to keep documentation in sync e.g. the submodule points to a particular reference, when the doc gets updated new references are created and the project should point to the new reference.+===== Keep documentation in sync =====
  
-More information about git submodule can be found in the [[http://book.git-scm.com/5_submodules.html|Git Book]].+By including a git submodule inside a project, it is pointing to a specific reference, and you need to keep this reference up to date to point to the latest documentation. You should remember doing this at least before a new release. 
 + 
 +  - Get inside your project and make sure the submodule is initialized. 
 +    * ''cd <PROJECT>'' 
 +    * ''<nowiki>git submodule update --init</nowiki>'' 
 +  - Get inside the submodule and pull the latest revision. 
 +    * ''cd doc'' 
 +    * ''git pull'' 
 +  - You can check that the reference changed now. 
 +    * ''cd ..'' 
 +    * ''git status'' 
 +    * ''git diff'' 
 +  - Commit the new reference. 
 +    * ''git add doc'' 
 +    * ''<nowiki>git commit -m"Update documentation reference"</nowiki>'' 
 +    * ''git push'' 
 + 
 +For more information about git submodule you can check the [[http://book.git-scm.com/5_submodules.html|Git Book]].