Browse Source

Tweak docs

Thomas Buck 5 years ago
parent
commit
c0e0c0667e
2 changed files with 2 additions and 31 deletions
  1. 0
    8
      CONTRIBUTING.md
  2. 2
    23
      README.md

+ 0
- 8
CONTRIBUTING.md View File

@@ -6,10 +6,6 @@ Make sure you agree with the license (GPLv3). See [LICENSE.md](./LICENSE.md) for
6 6
 
7 7
 Code that is committed to the master branch should work with both Debian 8 "Jessie" and Ubuntu 16.04 LTS "Xenial".
8 8
 
9
-## Development environment
10
-
11
-You'll want to set up a [local development environment](https://github.com/sovereign/sovereign/wiki/Development-Environment) so that you don't have to test on a remote server.
12
-
13 9
 ## Module design principles
14 10
 
15 11
 Sovereign is an Ansible playbook that uses the modules in this repository to configure a server. Modules should conform to the following design principles.
@@ -42,10 +38,6 @@ A module's design should anticipate upgrades to the services it provides. Config
42 38
 
43 39
 A module should be designed and implemented to run as quickly as possible in order to minimize the time to run an entire playbook or even the role itself. A small performance penalty here and a small penalty there eventually adds to a very slow deployment system. Performance is important.
44 40
 
45
-### Tests
46
-
47
-A module should have tests. TBD: more about this and what the expectation is.
48
-
49 41
 ### Design document
50 42
 
51 43
 A module should have a design description explaining the approach to implementing a service and what tradeoffs were made when choosing the design that was implemented. Do not leave this for comments in a pull request as we want this close to the code for the sake of future maintainers.

+ 2
- 23
README.md View File

@@ -47,7 +47,7 @@ What You’ll Need
47 47
 ----------------
48 48
 
49 49
 1.  A VPS (or bare-metal server if you wanna ball hard). My VPS is hosted at [Linode](http://www.linode.com/?r=45405878277aa04ee1f1d21394285da6b43f963b). You’ll probably want at least 512 MB of RAM between Apache, Solr, and PostgreSQL. Mine has 1024.
50
-2.  [64-bit Debian 8.3](http://www.debian.org/) or an equivalent Linux distribution. (You can use whatever distro you want, but deviating from Debian will require more tweaks to the playbooks. See Ansible’s different [packaging](http://docs.ansible.com/ansible/list_of_packaging_modules.html) modules.)
50
+2.  [64-bit Debian 9](http://www.debian.org/). (You can use whatever distro you want, but deviating from Debian will require more tweaks to the playbooks. See Ansible’s different [packaging](http://docs.ansible.com/ansible/list_of_packaging_modules.html) modules.)
51 51
 
52 52
 You do not need to acquire an SSL certificate.  The SSL certificates you need will be obtained from [Let's Encrypt](https://letsencrypt.org/) automatically when you deploy your server.
53 53
 
@@ -124,7 +124,7 @@ Create `A` or `CNAME` records which point to your server's IP address:
124 124
 
125 125
 ### 6. Run the Ansible Playbooks
126 126
 
127
-First, make sure you’ve [got Ansible 1.9.3+ installed](http://docs.ansible.com/intro_installation.html#getting-ansible).
127
+First, make sure you’ve [got Ansible installed](http://docs.ansible.com/intro_installation.html#getting-ansible).
128 128
 
129 129
 To run the whole dang thing:
130 130
 
@@ -159,24 +159,3 @@ Sign in to the ZNC web interface and set things up to your liking. It isn’t ex
159 159
 	ssh deploy@example.com -L 6643:localhost:6643
160 160
 
161 161
 Then proceed to http://localhost:6643 in your web browser.
162
-
163
-Similarly, to access the server monitoring page, use another SSH tunnel:
164
-
165
-    ssh deploy@example.com -L 2812:localhost:2812
166
-
167
-Again proceeding to http://localhost:2812 in your web browser.
168
-
169
-How To Use Your New Personal Cloud
170
-----------------------------------
171
-
172
-We’re collecting known-good client setups [on our wiki](https://github.com/sovereign/sovereign/wiki/Usage).
173
-
174
-Troubleshooting
175
----------------
176
-
177
-If you run into an errors, please check the [wiki page](https://github.com/sovereign/sovereign/wiki/Troubleshooting). If the problem you encountered, is not listed, please go ahead and [create an issue](https://github.com/sovereign/sovereign/issues/new). If you already have a bugfix and/or workaround, just put them in the issue and the wiki page.
178
-
179
-IRC
180
-===
181
-
182
-Ask questions and provide feedback in `#sovereign` on [Freenode](http://freenode.net).

Loading…
Cancel
Save