Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
documentation:migrate-documentation [2010/11/11 09:24] – created mike | documentation:migrate-documentation [2010/11/12 20:11] (current) – [Keep documentation in sync] mike | ||
---|---|---|---|
Line 1: | Line 1: | ||
~~NOTRANS~~ | ~~NOTRANS~~ | ||
- | ====== | + | ====== |
- | To migrate existing documentation from your project you will need to create a branch inside the // | + | 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 |
===== Xfce4-docs branch ===== | ===== Xfce4-docs branch ===== | ||
Line 31: | Line 31: | ||
* ''< | * ''< | ||
- | By now when a user clones the repository, the content of the submodule will automatically be initialized by running the '' | + | By now when a user clones the repository, the content of the submodule will automatically be initialized by running the '' |
- | * 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:// | + | 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. | ||
+ | * '' | ||
+ | * ''< | ||
+ | - Get inside the submodule and pull the latest revision. | ||
+ | * '' | ||
+ | * '' | ||
+ | - You can check that the reference changed now. | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | - Commit the new reference. | ||
+ | * '' | ||
+ | * ''< | ||
+ | * '' | ||
+ | |||
+ | For more information about git submodule |