Merge ~cjwatson/launchpad:redistribute-faq into launchpad:master

Proposed by Colin Watson
Status: Merged
Approved by: Colin Watson
Approved revision: 8d9164b3d8bcca85651898009f37f2396f838e3f
Merge reported by: Otto Co-Pilot
Merged at revision: not available
Proposed branch: ~cjwatson/launchpad:redistribute-faq
Merge into: launchpad:master
Diff against target: 174 lines (+48/-42)
7 files modified
doc/explanation/index.rst (+1/-0)
doc/explanation/navigating.rst (+8/-0)
doc/explanation/postgresql.rst (+3/-38)
doc/explanation/running-details.rst (+8/-0)
doc/how-to/running.rst (+28/-1)
doc/index.rst (+0/-2)
doc/overview.rst (+0/-1)
Reviewer Review Type Date Requested Status
Jürgen Gmach Approve
Review via email: mp+427502@code.launchpad.net

Commit message

Remove FAQ and redistribute its contents

Description of the change

Daniele Procida's opinion was that FAQs are an antipattern in documentation, essentially (I think) because they tend not to actually be what's frequently asked. It would make more sense to distribute the material here into other relevant pages anyway, so do so.

I omitted "What version of Python is required?" entirely, since that's already covered near the top of `doc/how-to/running.rst`.

To post a comment you must log in.
Revision history for this message
Jürgen Gmach (jugmac00) wrote :

I certainly agree with Daniele here, and I try to convince the other maintainers of tox also removing the faq section, which by far - is no faq section.

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/doc/explanation/index.rst b/doc/explanation/index.rst
2index c6b72d0..9b66e6d 100644
3--- a/doc/explanation/index.rst
4+++ b/doc/explanation/index.rst
5@@ -9,6 +9,7 @@ Explanation
6 running-details
7 framework
8 navigating
9+ postgresql
10 architecture
11 pip
12 favicon
13diff --git a/doc/explanation/navigating.rst b/doc/explanation/navigating.rst
14index 277d452..7b77ac5 100644
15--- a/doc/explanation/navigating.rst
16+++ b/doc/explanation/navigating.rst
17@@ -65,3 +65,11 @@ of the ones that come up from time to time.
18
19 ``zcml/``
20 Various configuration files for the Zope services.
21+
22+Can I look at the code without downloading it all?
23+==================================================
24+
25+Yes, you can browse the `source code
26+<https://git.launchpad.net/launchpad/tree>`_ on Launchpad. You can also use
27+``git clone https://git.launchpad.net/launchpad`` to download the code
28+without setting up a development environment.
29diff --git a/doc/faq.rst b/doc/explanation/postgresql.rst
30similarity index 52%
31rename from doc/faq.rst
32rename to doc/explanation/postgresql.rst
33index cc7a6a7..1a4224e 100644
34--- a/doc/faq.rst
35+++ b/doc/explanation/postgresql.rst
36@@ -1,12 +1,6 @@
37-==========================
38-Frequently Asked Questions
39-==========================
40-
41-Are there Launchpad packages available?
42-=======================================
43-
44-No, Launchpad is not packaged and there are no plans to do so. Launchpad
45-deployment is done straight from Git branches and is quite complex.
46+========================
47+PostgreSQL and Launchpad
48+========================
49
50 Why PostgreSQL?
51 ===============
52@@ -29,32 +23,3 @@ Highly. We make use of PostgreSQL specific features, such as:
53 * Transactional DDL
54 * tsearch2 full text search
55 * Database permissions
56-
57-What version of Python is required?
58-===================================
59-
60-Currently, Python 3.5.
61-
62-Can I look at the code without downloading it all?
63-==================================================
64-
65-Yes, you can browse the `source code
66-<https://git.launchpad.net/launchpad/tree>`_ on Launchpad. You can also use
67-``git clone https://git.launchpad.net/launchpad`` to download the code
68-without setting up a development environment.
69-
70-I have Launchpad running but mails are not sent...
71-==================================================
72-
73-Development Launchpads don't send email to the outside world, for obvious
74-reasons. They connect to the local SMTP server and send to root. To create
75-new users, create a new account and check the local mailbox, or see
76-:doc:`how-to/new-user`.
77-
78-My database permissions keep getting deleted!
79-=============================================
80-
81-If your local account is called "launchpad" it conflicts with a role called
82-"launchpad" which is defined in ``database/schema/security.cfg``. You need
83-to rename your local account and re-assign it superuser permissions as the
84-``utilities/launchpad-database-setup`` script does.
85diff --git a/doc/explanation/running-details.rst b/doc/explanation/running-details.rst
86index aad600b..27925ce 100644
87--- a/doc/explanation/running-details.rst
88+++ b/doc/explanation/running-details.rst
89@@ -55,3 +55,11 @@ Get the code:
90 $ utilities/update-sourcecode
91 $ git clone --depth=1 https://git.launchpad.net/lp-source-dependencies download-cache
92 $ make
93+
94+Are there Launchpad packages available?
95+---------------------------------------
96+
97+No, Launchpad is not packaged as a ``.deb`` or a snap or anything like that,
98+and there are no plans to do so. Launchpad deployment is done straight from
99+Git branches. We don't want to increase complexity further by adding a
100+packaging method that we wouldn't use ourselves.
101diff --git a/doc/how-to/running.rst b/doc/how-to/running.rst
102index 574f9b6..0b4f777 100644
103--- a/doc/how-to/running.rst
104+++ b/doc/how-to/running.rst
105@@ -76,7 +76,9 @@ installed and configured on your network.
106 1. If you haven't done so already, run this script to set up LXD to let you
107 use your home directory inside the container. Some developers prefer to
108 only mount a subdirectory of their home directory in the container: to do
109- that, replace ``$HOME`` with ``$HOME/src`` or similar.
110+ that, replace ``$HOME`` with ``$HOME/src`` or similar. Although it may
111+ be tempting, make sure not to call your local user "launchpad", as that
112+ will break; see :ref:`database-permissions`.
113
114 .. code-block:: sh
115
116@@ -349,6 +351,9 @@ Or you can be at a prompt in the same directory and run this:
117 Troubleshooting
118 ===============
119
120+Network connectivity
121+--------------------
122+
123 "The LXC container is not getting an IPv4 address assigned and the network
124 connectivity inside the container doesn't work."
125
126@@ -365,3 +370,25 @@ the bridge interface on your computer):
127
128 sudo ufw allow in on lxdbr0
129 sudo ufw route allow in on lxdbr0
130+
131+Email
132+-----
133+
134+"I have Launchpad running but emails are not sent."
135+
136+Development Launchpads don't send email to the outside world, for obvious
137+reasons. They connect to the local SMTP server and send to root. To create
138+new users, create a new account and check the local mailbox, or see
139+:doc:`new-user`.
140+
141+.. _database-permissions:
142+
143+Database permissions
144+--------------------
145+
146+"My database permissions keep getting deleted!"
147+
148+If your local account is called "launchpad" it conflicts with a role called
149+"launchpad" which is defined in ``database/schema/security.cfg``. You need
150+to rename your local account and re-assign it superuser permissions as the
151+``utilities/launchpad-database-setup`` script does.
152diff --git a/doc/index.rst b/doc/index.rst
153index 2eb87a4..bab273e 100644
154--- a/doc/index.rst
155+++ b/doc/index.rst
156@@ -41,8 +41,6 @@ Overview
157 - How do Launchpad's features fit together?
158 * - :doc:`values`
159 - Guidelines for designing Launchpad
160- * - :doc:`faq`
161- -
162 * - :doc:`historical`
163 -
164
165diff --git a/doc/overview.rst b/doc/overview.rst
166index 12a41dc..fc41b9d 100644
167--- a/doc/overview.rst
168+++ b/doc/overview.rst
169@@ -9,5 +9,4 @@ Overview
170 strategy
171 scope
172 values
173- faq
174 historical

Subscribers

People subscribed via source and target branches

to status/vote changes: