Commit graph

159 commits

Author SHA1 Message Date
Jacob Hoffman-Andrews
ebf5170d12 Update testing docs. (#4211)
Recommend faster-running commands with clearer output first, building up to
slow, noisy, `tox` last.

Remove outdated Boulder testing advice, and outdated Boulder testing scripts
(Vagrantfile, mac-bootstrap.sh, boulder-start.sh). Update Boulder testing
section.

Fill out "directory structure" section of contributing guide a little better.
2017-02-16 12:39:17 -08:00
Josh Soref
6a39a42f45 Spelling (#4101)
* spelling: action

* spelling: artifacts

* spelling: asymmetric

* spelling: attempts

* spelling: bizarre

* spelling: certbot

* spelling: certificate

* spelling: certainly

* spelling: challenge

* spelling: client

* spelling: collated

* spelling: correct

* spelling: considered

* spelling: custom

* spelling: distinguish

* spelling: encoding

* spelling: enhancement

* spelling: equivalent

* spelling: execution

* spelling: existence

* spelling: failed

* spelling: handshake

* spelling: hyphen

* spelling: initialized

* spelling: initialization

* spelling: interpretation

* spelling: letsencrypt

* spelling: multiline

* spelling: multipart

* spelling: necessary

* spelling: otherwise

* spelling: output

* spelling: overridden

* spelling: positives

* spelling: preferable

* spelling: progress

* spelling: recommended

* spelling: referring

* spelling: relativity

* spelling: request

* spelling: requiring

* spelling: separate

* spelling: source

* spelling: specified

* spelling: standard

* spelling: successfully

* spelling: unparseable

* spelling: useful
2017-01-26 16:21:54 -08:00
Peter Eckersley
169b30aa90 Fix reference to letsencrypt-auto (#4085) 2017-01-19 13:50:07 -08:00
Brad Warren
bb669528b3 Remove old references to pep8 in our code (#4073) 2017-01-19 11:21:25 -08:00
Lipis
bba5d7d950 Rename OS X -> macOS (#3965)
* Rename OS X -> macOS

* Revert *-auto
2017-01-10 12:24:15 -08:00
Nick Fong
b0e4054b53 Add information on updating [certbot|letsencrypt]-auto (#3983)
* Add information on updating [certbot|letsencrypt]-auto

See #3703

* Add more information about when [le|cb]-auto is updated
2017-01-07 16:45:44 -08:00
Erica Portnoy
3b233df2b1 Update docs/contributing.rst to match display behavior during release. (#3674) 2017-01-04 14:42:52 -05:00
Jacob Hoffman-Andrews
e49a41be34 Change "hacking" to "getting started" in the docs 2016-08-08 12:17:42 -07:00
Brad Warren
7a0d4d48a0 Remove broken known issues link 2016-07-25 12:54:14 -07:00
bmw
950710bdce Merge pull request #3042 from TheNavigat/envlist
Limiting tox envlist to really needed tests
2016-06-17 12:37:17 -07:00
Amjad Mashaal
31d9fc7d86 Adding --skip-missing-interpreters to constributing.rst "Submitting a pull request" section 2016-06-17 04:13:44 +02:00
Noah Swartz
092173c608 fix broken link in contributing.rst (#3130) 2016-06-06 17:05:51 -07:00
Amjad Mashaal
4a8f71277c Limiting tox envlist to really needed tests 2016-05-28 02:03:51 +02:00
Noah Swartz
4b1d9e0af2 Merge pull request #2986 from certbot/doc-cleanup
Doc cleanup
2016-05-16 20:14:02 -07:00
John Reed
1aff941ad0 Updating broken link to Google Python Style guide
Old link: https://google-styleguide.googlecode.com/svn/trunk/pyguide.html
New link: https://google.github.io/styleguide/pyguide.html
2016-05-13 18:37:43 -05:00
Peter Eckersley
f16104e3cb Lots of doc cleanups 2016-05-13 12:22:55 -07:00
Noah Swartz
891b186856 changed wiki refs, added some words 2016-05-03 17:04:30 -07:00
Noah Swartz
8f6c289e78 incorperate jsha's comments 2016-05-02 13:59:42 -07:00
Noah Swartz
2f81a8963e move github refs back to LE 2016-04-21 15:18:27 -07:00
Noah Swartz
2646ad4262 edit contributing.rst 2016-04-18 15:08:16 -07:00
Noah Swartz
b284d54c77 reslove certbot name change 2016-04-18 14:56:02 -07:00
Brad Warren
a64d8b7e00 Update contributing instructions 2016-04-14 15:16:48 -07:00
Noah Swartz
e2af5ab9b4 updated docs with s/letsencrypt/certbot/g and more 2016-04-01 16:42:44 -07:00
Peter Eckersley
ceae505751 Merge pull request #2476 from moshevds/etc_hosts
Adding required /etc/hosts entries to .travis.yml and docs/contributing.rst
2016-02-16 16:15:32 -08:00
TheNavigat
89916e726c Adding required /etc/hosts entries to docs/contributing.rst 2016-02-15 17:31:47 +01:00
TheNavigat
037cc4e150 Adding running boulder-start.sh on boot 2016-02-12 13:47:50 +02:00
Peter Eckersley
64600ff61c Place a signpost about default detection for plugin args 2016-02-09 17:52:30 -08:00
Erik Rose
505e66b57c Move the venv setup scripts to the tools folder.
They were the last things left in the bootstrap folder, and they were lonely.
2016-02-05 18:31:41 -05:00
Peter Eckersley
2f29c66167 Merge pull request #2232 from TheNavigat/golangcontributing
Refining contributing.rst
2016-01-25 10:20:07 -08:00
TheNavigat
b5af4264bc Adding instructions on how to install Go 1.5.3 on Linux 2016-01-23 04:14:23 +02:00
Brad Warren
bccb2124bc Fix paths in contributing.rst 2016-01-13 14:05:19 -08:00
Erik Rose
f2586fbc11 Merge master in so Travis will test this PR. 2016-01-08 17:08:30 -05:00
bmw
e8705720be Merge pull request #1593 from TheNavigat/read-the-docs-python
Adding Python 2.6+ note to docs
2016-01-08 16:33:32 -05:00
Erik Rose
cad4e98003 Merge in master to get up to date.
Bootstrap scripts and letsencrypt-auto itself required some merge work.
2016-01-05 17:29:52 -05:00
TheNavigat
f5a0268f17 Adding Python 2.6/2.7 note to the docs 2015-12-25 20:09:42 +02:00
Peter Eckersley
3dc3df4b34 Document the inclusion of apacheconftest in tox 2015-12-23 10:58:28 -08:00
Erik Rose
ec9a498622 Move OS-package bootstrappers to a private folder.
They're now used only by the le-auto build process. The new public interface for OS-level bootstrapping is le-auto --os-packages-only, which dispatches by OS automatically. That obsoletes install-deps.sh as well, saving some repetition.

Also, switch to mustache-style templating to avoid colliding with shell variable references.

To optimize for the docker cache, we could later add a shim script that sources just deb_common.sh and calls its bootstrap function.
2015-12-02 11:12:57 -05:00
Erik Rose
e3ace6f84c Split large independent scripts off from the main body of the proof-of-concept script. Integrate the bits of the old le-auto script that are still useful.
This makes the script more readable and easier to work on. We'll stitch it together with a build process.

Also, stop passing the sudo command as an arg to the experimental bootstrappers. They will be inlined into the main script and can just reference $SUDO. As a result, stop recommending devs run the scripts manually, instead running le-auto --os-packages-only. This has the nice side effect of making dev documentation simpler.

Name the folder "letsencrypt_auto" rather than "letsencrypt-auto" because git yield endless pain when replacing a file with a dir. Perhaps we can change it with impunity in a latter commit.
2015-12-02 00:48:18 -05:00
Jakub Warmuz
bbb7606fe1
Kill dvsni in acme 2015-11-07 18:35:41 +00:00
Liam Marshall
593b4b5eec Add notices about known issues to docs 2015-11-04 21:31:18 -06:00
Jakub Warmuz
602f0b2dbe
Add http-01 to acme 2015-11-01 11:01:22 +00:00
Christopher Manning
3ecf38b401 Vagrantfile: use recommended bootstrap scripts for provisioning
Also remove an incorrect command from the Vagrant instructions in
`docs/contributing.rst`.
2015-10-27 17:34:18 -05:00
Jakub Warmuz
ae9e5f7fff
Revert to {using,contributing}.rst 2015-10-25 10:14:40 +00:00
Jakub Warmuz
cf26d014cd
{dev,user,packaging}.rst rename 2015-10-24 20:28:41 +00:00
Jakub Warmuz
0233f2e9ac
docs headers: User/Developer/Packaging Guide 2015-10-24 20:28:41 +00:00
Jakub Warmuz
d079df9cd5
docs: move plugins.rst to dev guide section 2015-10-24 20:28:41 +00:00
Jakub Warmuz
c84e9b2950
Add TOC to dev guide 2015-10-24 20:28:41 +00:00
Jakub Warmuz
6135fbdc18
docs: fix prerequisites ref 2015-10-24 20:28:40 +00:00
Brad Warren
d4ed2d44e1 source 2015-10-23 18:44:33 -07:00
Peter Eckersley
efa1d6d38e Reintroduce a bit more verbosity about virtualenv? 2015-10-23 17:27:55 -07:00
Peter Eckersley
6b6a20b5e5 typo 2015-10-23 17:24:17 -07:00
Peter Eckersley
aa3f493341 Fix fragment link nit 2015-10-23 17:23:26 -07:00
Peter Eckersley
49a26ad013 Merge remote-tracking branch 'origin/master' into devdocs 2015-10-23 16:44:30 -07:00
Peter Eckersley
e19e0dc2e9 This section is now redundant 2015-10-23 16:18:08 -07:00
Peter Eckersley
096b5ec32a Back out ./letsencrypt-dev; document "activate" more clearly 2015-10-23 16:12:33 -07:00
Peter Eckersley
ad56bbbceb Cleanup plugin docs 2015-10-23 15:00:00 -07:00
Peter Eckersley
027a7d755d Update developer docs
- Discuss letsencrypt-dev
 - Be clearer in general
2015-10-23 15:00:00 -07:00
Joerg Sonnenberger
547e0d278d Typo 2015-10-23 01:48:25 +02:00
Jakub Warmuz
f922b9b694 Split docs into subpkgs (fixes #969) 2015-10-21 17:06:36 -07:00
Andrew Murray
fbe116c386 Fixed typos 2015-10-21 22:57:30 +11:00
Peter Eckersley
0fb8e3c479 Move augeaus & venv references 2015-10-15 00:07:26 -07:00
Peter Eckersley
0fb00ca039 Try to make the dependencies link work 2015-10-15 00:03:49 -07:00
Peter Eckersley
87000ac5c6 Move docker back into "using"
It seems the changes removing bootstrap from "using" weren't commited earlier,
either
2015-10-14 22:24:57 -07:00
Peter Eckersley
8a5d199ddf Try to make the "using" instructions as simple and accurate as possible
Some of the verbose stuff we had before is really of historical/developer
interest only
2015-10-14 18:35:34 -07:00
bmw
b56467c0c0 Merge pull request #907 from ArchimedesPi/instructions-for-a-new-pr
Add instructions for submitting a PR
2015-10-11 12:26:03 -07:00
Liam Marshall
454a661d44 contributing.rst: fix nits pointed out by @kuba 2015-10-09 15:46:03 -05:00
Brad Warren
b275df13d3 python2 and clarified coverage 2015-10-06 10:49:33 -07:00
Liam Marshall
a4e5f29856 Add link to instructions for running integration tests 2015-10-05 18:25:33 -05:00
Liam Marshall
973cd6ce42 Add instructions for submitting a PR. 2015-10-05 18:23:30 -05:00
Jakub Warmuz
26e03dbba2
docs: remove venv3. 2015-10-05 22:12:21 +00:00
Jakub Warmuz
18f1bb49f0
Merge remote-tracking branch 'github/letsencrypt/master' into bootstrap 2015-10-05 21:38:06 +00:00
Brandon Kreisel
8409c9c658 Meddle with more documentation and learn how to bash flag 2015-10-03 11:27:39 -04:00
Brandon Kreisel
0868a5962f Add documentation for OS X bootstrap script 2015-10-02 22:37:22 -04:00
Jakub Warmuz
6649af9479
Developer virtualenv bootstrap scripts. 2015-09-27 20:57:31 +00:00
yan
5b080b6056 Update Dockerfile-dev and instructions. 2015-09-21 15:33:40 -07:00
Jakub Warmuz
03e2f043df
Address #726 review comments 2015-09-16 06:49:04 +00:00
Peter Eckersley
2611a7bce8 Merge pull request #726 from letsencrypt/doc
Document more dependencies for integration testing
2015-09-15 18:04:56 -07:00
James Kasten
3c79845b16 Merge pull request #769 from rutsky/patch-2
fix path to script with nginx prerequisites
2015-09-13 17:15:35 -04:00
Vladimir Rutsky
d3cb4746e9 fix path to script with nginx prerequisites
The path is copied from `.. include` directive below.
2015-09-13 09:53:53 +03:00
Vladimir Rutsky
06d87cb56c fix typo: "Python'd" -> "Python's" 2015-09-13 09:47:56 +03:00
Jakub Warmuz
71e665d4cd
Easier coverage testing for subpackages.
You can now call "./tox.cover.sh acme", "./tox.cover acme letsencrypt"
etc. to scope down coverage testing to particular
subpackages. "./tox.cover.sh" checks coverage for all packages.
2015-09-06 12:12:02 +00:00
Peter Eckersley
ea9e4d5cd7 Document more dependencies for integration testing 2015-08-28 09:57:30 -07:00
James Kasten
8a6dfb1516 Merge pull request #703 from kuba/docs
Fix various Sphinx warnings, errors
2015-08-24 17:08:53 -04:00
Jakub Warmuz
b2b042837f
Use Go 1.5.
The following PRs broke our unittests:

- https://github.com/letsencrypt/boulder/pull/642
- https://github.com/letsencrypt/boulder/pull/635
2015-08-23 21:10:56 +00:00
Jakub Warmuz
4b128c69a2
Fix docs include (SEVERE) 2015-08-22 14:30:30 +00:00
James Kasten
c1f9d66a09 update docs to include letshelp-letsencrypt 2015-08-17 10:51:44 -07:00
James Kasten
5898bd41e2 Merge pull request #647 from diracdeltas/feature/docker-dev
Add development Dockerfile and instructions
2015-08-13 17:04:29 -04:00
James Kasten
471d168665 Merge pull request #672 from frennkie/master
Minor enhancements (fix typo in docs, remove unneeded code for better cov)
2015-08-12 13:32:42 -04:00
Vinney
637bc840ac Fix typo in command code block in contributing.rst 2015-08-12 12:12:00 -04:00
Robert Habermann
6a1cf1b754 fix typo in tox.cover.sh script name 2015-08-09 11:11:23 +02:00
yan
b38500fad8 Add development Dockerfile and instructions 2015-08-03 16:26:22 -07:00
Jakub Warmuz
a462e38cab
Update package references after subdirs rename. 2015-07-11 04:33:07 +00:00
Jakub Warmuz
b9df69af9f
Basic dev/test setup for separate package subdirectories. 2015-07-10 16:38:42 +00:00
Jakub Warmuz
2c6ef0feef
Update hacking docs (venv/bin/activate, ./tox-cover.sh, integration, ipdb). 2015-07-06 09:19:00 +00:00
Jakub Warmuz
15258cc50a
Update references after repo rename.
https://github.com/letsencrypt/letsencrypt/issues/505
2015-06-24 04:56:31 +00:00
Jakub Warmuz
50e509604c
Docs: remove wrong re-install comment 2015-06-20 10:20:54 +00:00
Jakub Warmuz
a1f5ea8e8c
Docs: note about pip editable mode. 2015-06-19 11:13:38 +00:00
Jakub Warmuz
887f91bdac
requirements.txt: no editable (-e) mode, no "." install. 2015-06-09 07:51:42 +00:00
Jakub Warmuz
41e86df252
Move letsencrypt.client to letsencrypt 2015-05-10 12:32:05 +00:00
Jakub Warmuz
3a6bd7123d
Move acme to top-level 2015-05-10 12:26:17 +00:00