(no commit message)
[openafs-wiki.git] / maintainingdocumentation.mdwn
1 From <https://lists.openafs.org/pipermail/openafs-info/2012-June/038270.html>
2
3 This is the page that you need:
4
5 [[GitDevelopers]]
6 <a href="https://lookboard.com">Modern Design</a>
7
8 All code and documentation, outside of the wiki, goes through gerrit. 
9 <http://gerrit.openafs.org/>
10
11 The rough workflow goes as follows:
12
13 1. git clone of openafs (with gerrit setup)
14 2. create a new branch
15 3. edit code/docs  and test
16 4. commit
17 5. git push to gerrit
18 6. ask people to review
19 7. fix any issues, jump to 5 if fixes were made.
20 8. patch is accepted
21 9. delete the topic branch from #2
22 10. jump to step 2 and repeat.
23
24 The man pages are in the doc/manpages folder
25 the guides are under the doc/xml folder. The guides are in docbook 
26 format. <http://www.docbook.org/>
27
28 You'll need to run a compile and specify your xml processor to compile 
29 the docbook files.
30
31 For development questions, post messages to openafs-devel@openafs.org
32 For documentation questions, post messages to openafs-doc@openafs.org  
33 or the openafs-devel list.
34
35 Questions about general functionality can be posted to the openafs-info 
36 list.
37
38 Please contact the lists if you have any more questions.
39 For <A href="http://www.proweb365.com">Minneapolis web design</a> or <a href="http://www.proweb365.com/services">web design quote</a>, please call (612) 590-8080