Bazaar

Merge lp:~nmb/bzr/admin-guide-structure into lp:bzr

  1. admin-guide-structure
  2. Merge into bzr.dev
Proposed by Neil Martinsen-Burrell
Status: Merged
Approved by: Ian Clatworthy
Approved revision: not available
Merged at revision: not available
Proposed branch: lp:~nmb/bzr/admin-guide-structure
Merge into: lp:bzr
Diff against target: 394 lines (+169/-117)
16 files modified
Makefile (+6/-1)
doc/en/admin-guide/advanced.txt (+14/-0)
doc/en/admin-guide/backup.txt (+8/-0)
doc/en/admin-guide/code-browsing.txt (+7/-0)
doc/en/admin-guide/hooks-plugins.txt (+14/-0)
doc/en/admin-guide/index-plain.txt (+23/-0)
doc/en/admin-guide/index.txt (+25/-114)
doc/en/admin-guide/integration.txt (+14/-0)
doc/en/admin-guide/introduction.txt (+11/-0)
doc/en/admin-guide/migration.txt (+8/-0)
doc/en/admin-guide/other-setups.txt (+13/-0)
doc/en/admin-guide/security.txt (+9/-0)
doc/en/admin-guide/simple-setups.txt (+5/-0)
doc/en/admin-guide/upgrade.txt (+11/-0)
doc/en/conf.py (+0/-2)
doc/en/index.txt (+1/-0)
To merge this branch: bzr merge lp:~nmb/bzr/admin-guide-structure
Reviewer Review Type Date Requested Status
Ian Clatworthy Approve
John A Meinel Approve
Review via email: mp+15759@code.launchpad.net
To post a comment you must log in.
Revision history for this message
Neil Martinsen-Burrell (nmb) wrote :

This branch makes a file structure for the admin guide and adds it to be built by ``make docs`` and Sphinx.

Revision history for this message
John A Meinel (jameinel) wrote :

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Neil Martinsen-Burrell wrote:
> Neil Martinsen-Burrell has proposed merging lp:~nmb/bzr/admin-guide-structure into lp:bzr.
>
> Requested reviews:
> bzr-core (bzr-core)
>
>
> This branch makes a file structure for the admin guide and adds it to be built by ``make docs`` and Sphinx.
>

This looks good to me. I don't think I have Sphynx here, but 'make docs'
 does create doc/en/admin-guide/index-plain.html and it seems properly
populated.

 review: approve

John
=:->

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (Cygwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAksdZPUACgkQJdeBCYSNAANqVACgqKXWn/KZ/98Adz6B4oR25TRA
+p0AoKKXjRQbw8dBIC2moiCsiwCX0azw
=y14d
-----END PGP SIGNATURE-----

review: Approve
Revision history for this message
Ian Clatworthy (ian-clatworthy) wrote :

Sweet. I'd link this into the main TOC while merging.

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'Makefile'
2--- Makefile 2009-11-18 06:18:14 +0000
3+++ Makefile 2009-12-07 18:25:22 +0000
4@@ -212,6 +212,7 @@
5 doc/ja/tutorials/centralized_workflow.txt \
6 $(wildcard doc/*/mini-tutorial/index.txt) \
7 $(wildcard doc/*/user-guide/index-plain.txt) \
8+ doc/en/admin-guide/index-plain.txt \
9 $(wildcard doc/es/guia-usario/*.txt) \
10 $(derived_txt_files) \
11 doc/en/upgrade-guide/index.txt \
12@@ -221,7 +222,8 @@
13 doc/en/user-guide/index.txt \
14 doc/es/user-guide/index.txt \
15 doc/ja/user-guide/index.txt \
16- doc/ru/user-guide/index.txt
17+ doc/ru/user-guide/index.txt \
18+ doc/en/admin-guide/index.txt
19 txt_files = $(filter-out $(txt_nohtml), $(txt_all))
20 htm_files = $(patsubst %.txt, %.html, $(txt_files))
21
22@@ -279,6 +281,9 @@
23 #doc/ru/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/ru/user-guide))
24 # $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
25 #
26+doc/en/admin-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/admin-guide))
27+ $(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
28+
29 doc/developers/%.html: doc/developers/%.txt
30 $(rst2html) --stylesheet=../default.css $< $@
31
32
33=== added file 'doc/en/admin-guide/advanced.txt'
34--- doc/en/admin-guide/advanced.txt 1970-01-01 00:00:00 +0000
35+++ doc/en/admin-guide/advanced.txt 2009-12-07 18:25:22 +0000
36@@ -0,0 +1,14 @@
37+Advanced Topics
38+===============
39+
40+System Monitoring
41+-----------------
42+
43+Capacity Planning Tips
44+----------------------
45+
46+Clustering
47+----------
48+
49+Multi-site Setups
50+-----------------
51
52=== added file 'doc/en/admin-guide/backup.txt'
53--- doc/en/admin-guide/backup.txt 1970-01-01 00:00:00 +0000
54+++ doc/en/admin-guide/backup.txt 2009-12-07 18:25:22 +0000
55@@ -0,0 +1,8 @@
56+Back-up and Restore
57+===================
58+
59+Filesystem Backups
60+------------------
61+
62+Bazaar as its own backup
63+------------------------
64
65=== added file 'doc/en/admin-guide/code-browsing.txt'
66--- doc/en/admin-guide/code-browsing.txt 1970-01-01 00:00:00 +0000
67+++ doc/en/admin-guide/code-browsing.txt 2009-12-07 18:25:22 +0000
68@@ -0,0 +1,7 @@
69+Web-based code browsing
70+=======================
71+Loggerhead
72+----------
73+
74+Other web interfaces
75+--------------------
76
77=== added file 'doc/en/admin-guide/hooks-plugins.txt'
78--- doc/en/admin-guide/hooks-plugins.txt 1970-01-01 00:00:00 +0000
79+++ doc/en/admin-guide/hooks-plugins.txt 2009-12-07 18:25:22 +0000
80@@ -0,0 +1,14 @@
81+Extending Bazaar with Hooks and Plugins
82+=======================================
83+
84+Email Notification
85+------------------
86+
87+Feed Generation
88+---------------
89+
90+Mirroring
91+---------
92+
93+Other Useful Plugins
94+--------------------
95
96=== added file 'doc/en/admin-guide/index-plain.txt'
97--- doc/en/admin-guide/index-plain.txt 1970-01-01 00:00:00 +0000
98+++ doc/en/admin-guide/index-plain.txt 2009-12-07 18:25:22 +0000
99@@ -0,0 +1,23 @@
100+###################################
101+Bazaar System Administrator's Guide
102+###################################
103+
104+.. Please mark sections in included files as following:
105+.. level 1 ========
106+.. level 2 --------
107+.. level 3 ~~~~~~~~
108+.. level 4 ^^^^^^^^ (it is better not to use nesting deeper than 3 levels)
109+
110+.. contents:: :depth: 3
111+
112+.. include:: introduction.txt
113+.. include:: simple-setups.txt
114+.. include:: other-setups.txt
115+.. include:: migration.txt
116+.. include:: hooks-plugins.txt
117+.. include:: code-browsing.txt
118+.. include:: integration.txt
119+.. include:: security.txt
120+.. include:: backup.txt
121+.. include:: upgrade.txt
122+.. include:: advanced.txt
123
124=== modified file 'doc/en/admin-guide/index.txt'
125--- doc/en/admin-guide/index.txt 2008-03-05 16:38:20 +0000
126+++ doc/en/admin-guide/index.txt 2009-12-07 18:25:22 +0000
127@@ -1,114 +1,25 @@
128-==========================
129-Bazaar Administrator Guide
130-==========================
131-
132-Note: this is a work in progress!
133-
134-.. contents:: Table of contents
135- :depth: 2
136-
137-Introduction
138-============
139-
140-Introduction to administering a Bazaar server installation.
141-
142-Scope of this guide
143--------------------
144-
145-What you need to run a Bazaar server
146-------------------------------------
147-
148-Platform requirements etc
149-
150-
151-Simple setup
152-============
153-
154-Smart server
155-------------
156-
157-Recommended tools
158------------------
159-
160-
161-Migration
162-=========
163-
164-Migrating from another VCS.
165-
166-Legacy VCS to bzr sync.
167-
168-
169-Hooks
170-=====
171-
172-
173-Web-based code browsing
174-=======================
175-
176-Loggerhead etc.
177-
178-
179-Integration with other tools
180-============================
181-
182-PQM
183----
184-
185-Bug trackers
186-------------
187-
188-Continuous integration tools
189-----------------------------
190-
191-e.g. Cruise Control
192-
193-Bundle Buggy
194-------------
195-
196-
197-Security
198-========
199-
200-Authentication
201---------------
202-
203-ACLs
204-----
205-
206-
207-Back-up and restore
208-===================
209-
210-
211-Upgrades
212-========
213-
214-Software upgrades
215------------------
216-
217-Disk format upgrades
218---------------------
219-
220-Plugin upgrades
221----------------
222-
223-
224-System monitoring
225-=================
226-
227-
228-Capacity planning tips
229-======================
230-
231-Disk management etc.
232-
233-
234-Advanced topics
235-===============
236-
237-Clustering
238-----------
239-
240-Multi-site setups
241------------------
242+###################################
243+Bazaar System Administrator's Guide
244+###################################
245+
246+.. Please mark sections in included files as following:
247+.. level 1 ========
248+.. level 2 --------
249+.. level 3 ~~~~~~~~
250+.. level 4 ^^^^^^^^ (it is better not to use nesting deeper than 3 levels)
251+
252+
253+.. toctree::
254+ :maxdepth: 2
255+
256+ introduction
257+ simple-setups
258+ other-setups
259+ migration
260+ hooks-plugins
261+ code-browsing
262+ integration
263+ security
264+ backup
265+ upgrade
266+ advanced
267
268=== added file 'doc/en/admin-guide/integration.txt'
269--- doc/en/admin-guide/integration.txt 1970-01-01 00:00:00 +0000
270+++ doc/en/admin-guide/integration.txt 2009-12-07 18:25:22 +0000
271@@ -0,0 +1,14 @@
272+Integration with Other Tools
273+============================
274+
275+Patch Queue Manager (PQM)
276+-------------------------
277+
278+Bug Trackers
279+------------
280+
281+Continuous Integration Tools
282+----------------------------
283+
284+Bundle Buggy
285+------------
286
287=== added file 'doc/en/admin-guide/introduction.txt'
288--- doc/en/admin-guide/introduction.txt 1970-01-01 00:00:00 +0000
289+++ doc/en/admin-guide/introduction.txt 2009-12-07 18:25:22 +0000
290@@ -0,0 +1,11 @@
291+Introduction
292+============
293+
294+Scope of this guide
295+-------------------
296+
297+What you need to run a Bazaar server
298+------------------------------------
299+
300+
301+
302
303=== added file 'doc/en/admin-guide/migration.txt'
304--- doc/en/admin-guide/migration.txt 1970-01-01 00:00:00 +0000
305+++ doc/en/admin-guide/migration.txt 2009-12-07 18:25:22 +0000
306@@ -0,0 +1,8 @@
307+Migration
308+=========
309+
310+Fast Import
311+-----------
312+
313+Subversion Conversion
314+---------------------
315
316=== added file 'doc/en/admin-guide/other-setups.txt'
317--- doc/en/admin-guide/other-setups.txt 1970-01-01 00:00:00 +0000
318+++ doc/en/admin-guide/other-setups.txt 2009-12-07 18:25:22 +0000
319@@ -0,0 +1,13 @@
320+Other Setups
321+============
322+
323+Dumb servers
324+------------
325+
326+Smart server over HTTP(S)
327+-------------------------
328+
329+Direct Smart Server Access
330+--------------------------
331+
332+
333
334=== added file 'doc/en/admin-guide/security.txt'
335--- doc/en/admin-guide/security.txt 1970-01-01 00:00:00 +0000
336+++ doc/en/admin-guide/security.txt 2009-12-07 18:25:22 +0000
337@@ -0,0 +1,9 @@
338+Security
339+========
340+
341+Authentication
342+--------------
343+
344+Access Control
345+--------------
346+
347
348=== added file 'doc/en/admin-guide/simple-setups.txt'
349--- doc/en/admin-guide/simple-setups.txt 1970-01-01 00:00:00 +0000
350+++ doc/en/admin-guide/simple-setups.txt 2009-12-07 18:25:22 +0000
351@@ -0,0 +1,5 @@
352+Simple Setups
353+=============
354+
355+Smart server
356+------------
357
358=== added file 'doc/en/admin-guide/upgrade.txt'
359--- doc/en/admin-guide/upgrade.txt 1970-01-01 00:00:00 +0000
360+++ doc/en/admin-guide/upgrade.txt 2009-12-07 18:25:22 +0000
361@@ -0,0 +1,11 @@
362+Upgrades
363+========
364+
365+Software upgrades
366+-----------------
367+
368+Disk format upgrades
369+--------------------
370+
371+Plugin upgrades
372+---------------
373
374=== modified file 'doc/en/conf.py'
375--- doc/en/conf.py 2009-09-09 13:34:08 +0000
376+++ doc/en/conf.py 2009-12-07 18:25:22 +0000
377@@ -73,8 +73,6 @@
378
379 # List of documents that shouldn't be included in the build.
380 unused_docs = [
381- # Placeholder for later
382- 'admin-guide/index',
383 # Subtopics that get included
384 'upgrade-guide/overview',
385 'upgrade-guide/data_migration',
386
387=== modified file 'doc/en/index.txt'
388--- doc/en/index.txt 2009-09-09 11:43:10 +0000
389+++ doc/en/index.txt 2009-12-07 18:25:22 +0000
390@@ -16,3 +16,4 @@
391 release-notes/index
392 upgrade-guide/index
393 user-reference/index
394+ admin-guide/index