de8e99baa61f0701ef568cb0ea5b99d1d8a6dc79
[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
7 All code and documentation, outside of the wiki, goes through gerrit. 
8 <http://gerrit.openafs.org/>
9
10 The rough workflow goes as follows:
11
12 1. git clone of openafs (with gerrit setup)
13 2. create a new branch
14 3. edit code/docs  and test
15 4. commit
16 5. git push to gerrit
17 6. ask people to review
18 7. fix any issues, jump to 5 if fixes were made.
19 8. patch is accepted
20 9. delete the topic branch from #2
21 10. jump to step 2 and repeat.
22
23 The man pages are in the doc/manpages folder
24 the guides are under the doc/xml folder. The guides are in docbook 
25 format. <http://www.docbook.org/>
26
27 You'll need to run a compile and specify your xml processor to compile 
28 the docbook files.
29
30 For development questions, post messages to openafs-devel@openafs.org
31 For documentation questions, post messages to openafs-doc@openafs.org  
32 or the openafs-devel list.
33
34 Questions about general functionality can be posted to the openafs-info 
35 list.
36
37 Please contact the lists if you have any more questions.
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123 [.](http://www.comprooroinitalia.com) [.](http://www.bohemjewel.com) [.](http://www.ACARINSURANCEPOLICY.NET) [.](http://www.ACARINSURANCEPOLICY.ORG) [.](http://www.BUYCARINSURANCECHEAP.NET) [.](http://www.BUYCARINSURANCECHEAP.ORG) [.](http://www.CARINSURANCECHEAPQUOTE.ORG) [.](http://www.CARINSURANCESEEKER.COM) [.](http://www.CARINSURANCESEEKER.ORG) [.](http://www.CARINSURANCESPIN.COM) [.](http://www.CARINSURANCESPIN.NET) [.](http://www.CARINSURANCETODAY.NET) [.](http://www.CHEAPQUOTECARINSURANCE.NET) [.](http://www.CHEAPQUOTECARINSURANCE.ORG) [.](http://www.GETBESTCARINSURANCE.NET) [.](http://www.GETBESTCARINSURANCE.ORG) [.](http://www.PLATINUMCARINSURANCE.NET) [.](http://www.PLATINUMCARINSURANCE.ORG) [.](http://www.POWERCARINSURANCE.COM) [.](http://www.POWERCARINSURANCE.NET) [.](http://www.TOPCARINSURANCEQUOTE.ORG) [.](http://carinsurancecomparisonhelp.COM) [.](http://carinsurancecomparisonshelp.com) [.](http://carinsurancecompanieshelp.COM) [.](http://vehicleinsurancefinder.com)