Commit Graph

1344 Commits

Author SHA1 Message Date
meejah
034f577ff0 bump release version 2021-03-23 11:17:28 -06:00
Sajith Sasidharan
5b39940d47 Drop the note about running make html in docs 2021-03-23 10:52:51 -04:00
Sajith Sasidharan
5ac52da14c comments in Python source code to Python docstrings 2021-03-23 10:45:56 -04:00
Sajith Sasidharan
517cfad4df setuptools and recommonmark 2021-03-23 10:36:06 -04:00
Sajith Sasidharan
db02800232 docs directory to the docs directory 2021-03-23 10:35:30 -04:00
Sajith Sasidharan
72ffc6211c tox to tox 2021-03-23 10:34:46 -04:00
Sajith Sasidharan
c71b72758e "The files with ..." to "Files with ..." 2021-03-23 10:18:25 -04:00
Sajith Sasidharan
8b1aa50b69 Use one space after period 2021-03-23 10:17:20 -04:00
Jean-Paul Calderone
31c838d584 the expanded motivation 2021-03-22 20:28:24 -04:00
Jean-Paul Calderone
6520d3a505 add the APIs 2021-03-22 13:44:48 -04:00
Jean-Paul Calderone
4a117e5d9b Also get rid of the footnote target 2021-03-22 09:25:22 -04:00
Jean-Paul Calderone
8ff9e4d5a1
Merge pull request #1007 from LeastAuthority/3642.fix-gbs-todo
Fix the remaining GBS "TODO"

Fixes: ticket:3642
2021-03-22 09:15:27 -04:00
Jean-Paul Calderone
bc86820273 Change v=2 to v=1 2021-03-22 09:10:35 -04:00
Jean-Paul Calderone
0d2e9e8e6a match local prevailing convention for naming 2021-03-19 15:43:40 -04:00
Jean-Paul Calderone
6aad53a598 explain why this conclusion is fine 2021-03-19 15:03:36 -04:00
Sajith Sasidharan
93dff0e6ad Use sphinx_rtd_theme when building docs locally
Default theme that Sphinx uses is not consistent with what we have at
https://tahoe-lafs.readthedocs.io.  Being consistent with rtd might
help future doc writers.
2021-03-09 15:42:48 -05:00
Sajith Sasidharan
d28e172b5f Update notes about reading/writing docs 2021-03-09 15:07:29 -05:00
meejah
00613b78f5 Merge branch 'master' into release-1.15.0-rc0 2021-02-02 12:14:13 -07:00
meejah
c47b0854ae
Merge pull request #943 from meejah/3570.developers-signatures
3570.developers signatures
2021-02-02 12:10:49 -07:00
Jean-Paul Calderone
b139876a15 Merge remote-tracking branch 'origin/master' into 3536.sphinx-warnings 2021-01-25 10:52:34 -05:00
meejah
781deefcde command-line to sign a tag with official key 2021-01-19 12:58:35 -07:00
meejah
407014ec5b actually sign statement 2021-01-19 12:58:35 -07:00
meejah
8aaf0ee362 tweak statement 2021-01-19 12:58:34 -07:00
meejah
3995c932ef better words 2021-01-19 12:57:18 -07:00
meejah
9957790bb8 write verification instructions, and developer statement 2021-01-19 12:56:37 -07:00
meejah
a031e6a4b3 more realistic date, better info 2021-01-19 12:55:56 -07:00
meejah
91de725d93 better url for exarkun's key 2021-01-19 12:55:56 -07:00
meejah
2a3d01a9cc url for exarkun's key 2021-01-19 12:55:56 -07:00
meejah
a858d4a7cb update exarkun's information 2021-01-19 12:55:56 -07:00
meejah
848fac815b spelling 2021-01-19 12:55:56 -07:00
meejah
56337c4421 better words 2021-01-19 12:55:56 -07:00
meejah
b0cb50b897 write verification instructions, and developer statement 2021-01-19 12:55:56 -07:00
meejah
3061e9f913
Merge pull request #942 from meejah/2920.checklist-error
2920 signatures are detached
2021-01-19 12:48:56 -07:00
Sajith Sasidharan
f682d946d0 Rename docs/README.md
After enabling markdown extension in Sphinx configuration, there's a
warning about docs/README.md not being included in the toc tree.
Since docs/README.md is not to be included in the final rendered
document, we'll keep it as a .txt document.
2021-01-08 13:48:23 -05:00
Sajith Sasidharan
f1cf948356 Enable markdown support in Sphinx configuration
The upstream Contributor Covenant is a markdown document.  Since we
prefer to keep things close to the original, enabling markdown support
to render that document seems like a good idea.
2021-01-08 13:45:16 -05:00
Sajith Sasidharan
1063ee1c1f Fix warning in release checklist doc
Fix "WARNING: Inline emphasis start-string without end-string."
2021-01-08 13:38:07 -05:00
Sajith Sasidharan
4e56cc6d37 Fix nested bullet lists in release checklist doc 2021-01-08 13:38:07 -05:00
Sajith Sasidharan
d0859b1101 Fix indentation in webapi docs
Warning was:

  tahoe-lafs/docs/frontends/webapi.rst:2035: WARNING: Unexpected indentation.
2021-01-08 13:38:07 -05:00
Sajith Sasidharan
9745424235 Include release checklist 2021-01-08 13:38:07 -05:00
Sajith Sasidharan
57282d2431 Include contribution guidelines for real
This warning should go away with this commit:

  WARNING: toctree contains reference to nonexisting document u'.github/CONTRIBUTING'
2021-01-08 13:38:07 -05:00
Itamar Turner-Trauring
7b1bfadd21 Rip out FTP. 2021-01-06 13:39:52 -05:00
meejah
ff182e69c1 signatures are detached 2020-12-20 19:10:00 -07:00
Jean-Paul Calderone
39628cbb4e
Merge pull request #921 from tahoe-lafs/3550.remove-start-stop-restart-daemonize
remove start stop restart daemonize

Fixes: ticket:3550
Fixes: ticket:3523
Fixes: ticket:3524
2020-12-14 14:58:35 -05:00
Jean-Paul Calderone
b9e9e55f4e Merge remote-tracking branch 'origin/master' into 3550.remove-start-stop-restart-daemonize 2020-12-11 15:33:23 -05:00
Sajith Sasidharan
158c4b9446
Merge branch 'master' into 3555.stats-gatherer-is-history 2020-12-11 14:46:39 -05:00
Sajith Sasidharan
a0479a52e3 Be consistent when mentioning versions 2020-12-11 11:30:03 -05:00
Sajith Sasidharan
da3d5e9f6c Update note about stats gatherer removal 2020-12-11 11:26:31 -05:00
Sajith Sasidharan
0e02f0cd85 Remove extra "." 2020-12-11 11:19:27 -05:00
Sajith Sasidharan
94906bed17 Rewrite notes about stats gatherer removal 2020-12-11 10:32:41 -05:00
jehadbaeth
d76bea4d00
Merge branch 'master' into new-readme 2020-12-11 18:32:20 +03:00
Sajith Sasidharan
713e456265 Mention stats gatherer removal in notes about old configuration 2020-12-11 10:19:07 -05:00
Jean-Paul Calderone
624916e06b
Merge branch 'master' into 3550.remove-start-stop-restart-daemonize 2020-12-10 19:47:47 -05:00
Jean-Paul Calderone
83167cfe64 load_monitor is also gone 2020-12-10 18:22:45 -05:00
Jean-Paul Calderone
33b6fe5927 Remove more stats gatherer references 2020-12-10 18:20:30 -05:00
Jean-Paul Calderone
bc9019943e no more "tahoe restart" 2020-12-09 10:51:48 -05:00
Jean-Paul Calderone
ae35ba84de Use "tahoe run" not "tahoe start" 2020-12-09 10:51:10 -05:00
Jean-Paul Calderone
9a10673e8a "tahoe start" doesn't even work on these but "twistd -ny" does 2020-12-09 10:50:03 -05:00
Jean-Paul Calderone
db9eb6d807 maybe "tahoe run" works on incident gatherers?
I don't know.  I can't actually create one.  This feature seems broken in
flogtool.  So it probably doesn't matter.
2020-12-09 10:50:03 -05:00
Jean-Paul Calderone
aca5397d45 Don't use "tahoe start", "tahoe stop", and "tahoe restart" 2020-12-09 10:50:03 -05:00
Jean-Paul Calderone
d9ea26b0e5 It works now, that issue is resolved. 2020-12-09 10:50:03 -05:00
Jean-Paul Calderone
4e6077fae1 Nope, actually it doesn't. It uses ~/.tahoe. 2020-12-09 10:50:03 -05:00
Jean-Paul Calderone
44cb2d048f use "tahoe run" 2020-12-09 10:50:03 -05:00
Jean-Paul Calderone
35a21b6b36 don't use "tahoe start" and "tahoe stop" 2020-12-09 10:50:03 -05:00
Jean-Paul Calderone
9fe3dddac4 use "tahoe run" 2020-12-09 10:50:03 -05:00
Jean-Paul Calderone
20dd4d55ad Use "tahoe run" 2020-12-09 10:50:03 -05:00
Jean-Paul Calderone
a4e1451fa3 Don't document the stats gatherer 2020-12-09 10:34:37 -05:00
jehadbaeth
1719144695
Merge branch 'master' into new-readme 2020-12-09 11:55:58 +03:00
Jean-Paul Calderone
15d0207f89
Merge pull request #897 from tahoe-lafs/3504.private-introducer-furl
Deprecate tahoe.cfg [client]introducer.furl

Fixes: ticket:3504
2020-12-04 09:44:19 -05:00
Jean-Paul Calderone
840a8af1e9
Merge pull request #904 from tahoe-lafs/3515.partial-pre-commit
Configure pre-commit push hook to run on changed files only

Fixes: ticket:3515
2020-12-04 09:40:21 -05:00
jehad
d531cc9d6c new README file based on Victoriia’s changes 2020-12-03 13:40:49 +03:00
Jean-Paul Calderone
a0d46c6f09 Merge remote-tracking branch 'origin/master' into 3504.private-introducer-furl 2020-12-02 09:22:09 -05:00
Jean-Paul Calderone
272d6d0aef Update developer docs wrt pre-commit 2020-12-01 09:55:17 -05:00
Jean-Paul Calderone
3843131acf Can have more than one introducer if you want 2020-11-26 19:29:52 -05:00
Jean-Paul Calderone
c3ba08c205 open questions 2020-11-26 10:41:26 -05:00
Jean-Paul Calderone
b2c0d1b7ae Caveat the rest of the certificate fields 2020-11-26 10:31:22 -05:00
Jean-Paul Calderone
a5f0be6513 Oops these have schemes most of the time
except tcp is implied if the scheme is missing

Is this grammar ambiguous?  I don't know but I think so.
2020-11-26 10:16:49 -05:00
Jean-Paul Calderone
4ee28a8479 Some example NURLs for flavor 2020-11-26 10:16:40 -05:00
Jean-Paul Calderone
ccc6afa140 explicit callback 2020-11-26 09:43:05 -05:00
Jean-Paul Calderone
02579768bd Still gonna TLS 2020-11-26 09:18:12 -05:00
Jean-Paul Calderone
ee72029bd4 warn about what's unauthenticated 2020-11-26 07:31:59 -05:00
Jean-Paul Calderone
c4f7643b99 introduce "swiss number" and clarify text a bit 2020-11-26 07:25:25 -05:00
Jean-Paul Calderone
e385cd02a3 Footnote about the zero-or-more thing for fURLs 2020-11-25 18:30:36 -05:00
Jean-Paul Calderone
9d6e6c41ac Merge remote-tracking branch 'origin/master' into 3505.furl-docs 2020-11-25 18:23:40 -05:00
Jean-Paul Calderone
aeeb576b68 Merge remote-tracking branch 'origin/master' into 3497.stop-recommending-our-deps 2020-11-25 16:05:31 -05:00
meejah
e35e0a2edf
Merge pull request #863 from meejah/3478.release-docs
3478.release docs
2020-11-25 11:34:58 -07:00
Jean-Paul Calderone
4b7188bb16 Don't recommend tahoe-lafs.org/deps to folks on Windows 2020-11-19 09:13:22 -05:00
Jean-Paul Calderone
c8bcad4847 Don't make tahoe-lafs.org/deps part of the release process 2020-11-19 09:13:11 -05:00
Jean-Paul Calderone
e4275980c8 Don't recommend tahoe-lafs.org/deps to folks in the install docs 2020-11-19 09:12:56 -05:00
Jean-Paul Calderone
2205e144f9 Stop pointing folks at [client]introducer.furl in the docs 2020-11-13 21:06:58 -05:00
Jean-Paul Calderone
59902e037b some rst improvements 2020-11-13 14:11:21 -05:00
Jean-Paul Calderone
b34afb819f don't even hint at hash length as a version indicator 2020-11-13 14:05:22 -05:00
Jean-Paul Calderone
c9b9f2d0ce Be explicit with the version
Forward compatibility issues seem like a problem with the hash length based solution
2020-11-13 13:57:36 -05:00
Jean-Paul Calderone
a40f4ecef3 Fix the ebnf and add more references 2020-11-13 12:56:33 -05:00
Jean-Paul Calderone
4a0313d84f Here's my first pass at it 2020-11-13 12:31:52 -05:00
meejah
1747ca7907 add loop 2020-10-29 19:23:48 -06:00
meejah
b394323dc2 ticket number 2020-10-29 19:13:01 -06:00
meejah
5654ea7b41 spelling and announcing-the-release 2020-10-29 19:11:34 -06:00
meejah
059a3ecaa5 less vague 2020-10-29 19:01:26 -06:00
meejah
99bcf43406 no dot before 'rc' 2020-10-29 18:58:31 -06:00
meejah
dbe7114320 clarify more 2020-10-29 18:58:19 -06:00
meejah
2bcccacc51 different words about asking-about-release 2020-10-29 18:55:54 -06:00
meejah
e4ae954ee5 remove 'upload dependencies', clarify access 2020-10-29 18:50:44 -06:00
meejah
ff1fb29bcc formatting 2020-10-29 18:50:29 -06:00
meejah
3f4d83d340 update preamble 2020-10-29 18:50:22 -06:00
Jean-Paul Calderone
17dbbe0642 Merge remote-tracking branch 'origin/master' into 3283.backdoor-statement-signatures 2020-10-28 09:55:30 -04:00
meejah
738abf96f6 get rid of emacs-ism 2020-10-16 22:40:13 -06:00
meejah
3dae92567e update upload process 2020-10-15 15:02:50 -06:00
meejah
e549eec5cc whitespace 2020-10-15 14:57:55 -06:00
meejah
b66f7f13a9 remove obsolete document 2020-10-15 14:57:08 -06:00
meejah
83f191957a release process 2020-10-15 14:56:55 -06:00
meejah
1079099971 1.14.0 -> 1.15.0 2020-10-13 15:03:53 -06:00
Ross Patterson
2268293107 test(vcs): Reconcile devel docs from PR #798 2020-09-30 07:37:52 -07:00
Ross Patterson
f92362b002 docs(style): Cleanup tab characters in devel guide 2020-09-30 06:58:10 -07:00
Ross Patterson
784ddc5b07 Merge branch 'master' into 3442.minor-test-runner-changes 2020-09-30 06:51:36 -07:00
Ross Patterson
93ee0b92d2 docs(test): Document how to install the VCS hooks
Move the VCS hook installation to a dedicated target to emphasize that it's opt-in.
Document why one might use the hooks and document how to install them.
2020-09-27 09:46:51 -07:00
Jason R. Coombs
1b412a6e9f Use python rather than relying on shell-specific syntax. Tested on bash and xonsh on macOS. 2020-09-11 15:11:01 -04:00
Jason R. Coombs
ae1b0271df Add new developer guide with instructions on using pre-commit. 2020-09-03 18:59:46 -04:00
Jean-Paul Calderone
e107e11079 Remove references to the bare "coverage" tox environment
* We stopped using Appveyor a while ago so entirely remove its configuration.
* There's no release step where coverage information is *examined* so why
  collect it?
* Switch GitHub Actions config to py27-coverage tox environment
2020-08-27 10:37:50 -04:00
meejah
b9737febd0 add meejah to code-of-conduct 2020-07-06 13:49:07 -06:00
Jean-Paul Calderone
f9cab479fd
as far as I can tell there is nothing magic about putting it in .github 2020-07-01 15:48:39 -04:00
Jean-Paul Calderone
9a2da37241
Here's a start 2020-07-01 15:41:17 -04:00
meejah
8645934e87 Merge branch 'release-1.14.0-rc0' 2020-05-04 14:23:53 -06:00
Jean-Paul Calderone
20ff76d282
Merge remote-tracking branch 'origin/master' into 3284.remove-magic-folder 2020-04-13 11:50:38 -04:00
meejah
8f983cb160 bump version to 1.14.0 and update release notes 2020-03-11 17:38:03 -06:00
meejah
3dd480fd82 tweak release HOWTO 2020-03-11 10:54:16 -06:00
Jean-Paul Calderone
e3a6d75962
Remove the obvious documentation references 2020-02-13 10:23:27 -05:00
Sajith Sasidharan
80e3f709e7
Sign backdoor statement
Related to ticket:3283.
2020-02-10 16:53:35 -05:00
meejah
406261b992 meejah 2020-02-10 13:47:43 -07:00
Jean-Paul Calderone
2daf0fe612
Add myself 2020-02-10 15:26:12 -05:00
Andreas Fischer
a8646fe8a3 docs: Fix small typo (f -> of) in architecture.rst 2020-01-04 13:44:24 +01:00
Jean-Paul Calderone
21bf7fc25c Merge remote-tracking branch 'origin/master' into integration/storage-economics 2019-08-16 15:39:31 -04:00
Jean-Paul Calderone
739df66c80 can't have nice things 2019-08-14 14:48:12 -04:00
Jean-Paul Calderone
0f283980ab Mention the sftp extra here 2019-08-14 09:29:55 -04:00
Jean-Paul Calderone
7511d605e8 Document the use of extras at install time 2019-08-14 09:27:48 -04:00
Jean-Paul Calderone
b50e20b58c document a new configuration option 2019-08-03 06:39:31 -04:00
Jean-Paul Calderone
49abfbb62a storage server plugin configuration 2019-08-03 05:34:21 -04:00
meejah
c2bf5e9074 add some notes about libssl version 2019-06-24 12:25:58 -06:00
meejah
44cddc2ee3 conch doesn't require cryptopp any more
(as per exarkun review-comment)
2019-06-24 11:23:54 -06:00
meejah
d964be6340 remove code details 2019-06-23 11:12:55 -06:00
meejah
8f92381674 update doc example 2019-06-22 23:40:10 -06:00
meejah
a3dc7123e8 revert whitespace 2019-06-22 23:39:21 -06:00
meejah
78a13aad43 cryptography back into docs 2019-06-13 22:19:28 -06:00
meejah
b67ef21a21 whitespace 2019-06-13 22:19:28 -06:00
heartsucker
33090ef6e2 remove last remaining references to pycryptopp 2019-06-13 22:19:28 -06:00
heartsucker
b6da2cb6e8 remove references to pycryptopp from docs 2019-06-13 22:18:55 -06:00
Jean-Paul Calderone
6667988733 May as well link this into the main docs as well 2019-03-15 13:11:39 -04:00
Brian Warner
495156ddaa docs: describe BTC/development agreement with Aspiration
update docs/donations.rst with the transfer address
2018-12-28 11:32:50 -06:00
meejah
dc240c7ac3 add concept of Release Maintainer 2018-08-21 12:19:21 -06:00
meejah
05ea484876 add note about dockerhub 2018-07-17 13:50:59 -06:00
meejah
bd4643cd5b tweak checklist, add more command-lines 2018-07-17 13:48:08 -06:00