Skip to content
This repository has been archived by the owner on Sep 1, 2022. It is now read-only.

Create End-User Kovri Documentation #256

Closed
1 task done
anonimal opened this issue Jul 22, 2016 · 2 comments
Closed
1 task done

Create End-User Kovri Documentation #256

anonimal opened this issue Jul 22, 2016 · 2 comments
Assignees
@anonimal
Labels
documentation enhancement major
Milestone
0.1.0-alpha

Comments

@anonimal
Copy link
Collaborator

By submitting this issue, I confirm the following:

  • I have read and understood the contributor guide.
  • I have checked that the issue I am reporting can be replicated or that the feature I am suggesting is not present.
  • I have checked opened or recently closed pull requests for existing solutions/implementations to my issue/suggestion.

Place an X inside the bracket to confirm

  • I confirm.

A proposal is now open to create end-user (mostly non-technical) documentation. I'll spare my fingers the details; please see references for more information.

Ticketing for housekeeping.
@anonimal anonimal self-assigned this Jul 22, 2016
anonimal added a commit to anonimal/kovri that referenced this issue Aug 22, 2016
@anonimal
Config: update and document kovri config file
79db048 
- Includes cleaned-up documentation that is given when issuing --help-with all
- Also, update default cli option for --log-to-file as was indicated in file

References monero-project#214, monero-project#256, and monero-project#314
@anonimal anonimal mentioned this issue Aug 22, 2016
Merged
1 task
@anonimal anonimal added this to the 0.1.0 milestone Sep 9, 2016
@anonimal anonimal mentioned this issue Sep 19, 2016
Closed
anonimal added a commit to anonimal/kovri that referenced this issue Oct 5, 2016
@anonimal
Docs: provide rudimentary end-user documentation
5d25a29 
References monero-project#256
anonimal added a commit to anonimal/kovri that referenced this issue Oct 5, 2016
@anonimal
Docs/Package: document and update tunnels.conf
bbbc334 
References monero-project#256
@anonimal anonimal mentioned this issue Oct 5, 2016
Merged
1 task
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 13, 2016
@anonimal
Moneropedia: initial commit for monero-project/kovri#256
87673cc 
- 12 new entries as they relate to Kovri
- They're mostly needed to satisfy the address book entry

References monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 13, 2016
@anonimal
Moneropedia: add Eepsite and Garlic Routing entries
9658bc6 
Referencing:
  - monero-project/kovri#256
  - monero-project#155
@anonimal
Copy link
Collaborator Author

Referencing anonimal/monero-site@9e7e99b and anonimal/monero-site@e8aa590 in addition to the previous commits.

anonimal added a commit to anonimal/monero-site that referenced this issue Oct 14, 2016
@anonimal
Moneropedia: add wikipedia URLs for Nick/Roger
40cebc7 
Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 14, 2016
@anonimal
Moneropedia: replace Onion Routing URL
13a74cf 
Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 14, 2016
@anonimal
Moneropedia: add Matryoshka doll comment in Garlic Routing
32f4f06 
Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 14, 2016
@anonimal
Moneropedia: add Reseed/Network Database/Router-Info entries
8af4ba7 
Also, minor adjustments elsewhere

Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 14, 2016
@anonimal
Moneropedia: add Router-Info and Floodfill entries
ce3dc6f 
Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 14, 2016
@anonimal
Moneropedia: add empty Lease-Set entry
bfa7a61 
Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 14, 2016
@anonimal
Moneropedia: remove redundant links + fix grammar
7fda45b 
For both the I2P and Java-I2P entries.

Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 14, 2016
@anonimal
Moneropedia: cleanup Java-I2P entry
e6661fc 
Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 15, 2016
@anonimal
Moneropedia: add/update/cleanup/fix entries
000e95c 
Added:
 - In-net
 - Lease
 - Message
 - I2NP (skeleton file)
 - Tunnel (skeleton file)

Updated/cleaned-up/fixed:
 - Router-Info
 - Lease-Set
 - Garlic-Routing
 - Floodfill
 - Destination

Note: term'ed lease-set to LeaseSet because of conflict with Lease

Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 15, 2016
@anonimal
Moneropedia: add Transports/SSU/NTCP
92b8462 
Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 15, 2016
@anonimal
Moneropedia: update NTCP/SSU/Transports entries
313b069 
Also:
 - Add more 'terms' in other entries
 - Separate @Kovri/@i2p (currently, @i2p is implied)

Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 16, 2016
@anonimal
Moneropedia: clarify type of I2P in Clearnet entry
3761e3b 
Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 18, 2016
@anonimal
Moneropedia: add Encryption related entries
1af1de0 
- Encryption (finished)
- Layered-Encryption (skeleton)

Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 18, 2016
@anonimal
Moneropedia: clarify Garlic Routing, add I2PControl
2681940 
Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 18, 2016
@anonimal
Moneropedia: link to Signature term in Encryption
31af021 
Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 18, 2016
@anonimal
Moneropedia: update/finish initial Kovri entry
d224710 
Also:
- adjust the case for all applicable terms
- minor clarification in canonically-unique-host
- add @encryption for several references to encryption

Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 19, 2016
@anonimal
Moneropedia: resolve various unfinished entries
841f7c1 
- Resolved TODO's for Base32/64-address, Destination, Transports

Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 19, 2016
@anonimal
Moneropedia: cleanup I2P entry
77d6cde 
Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 19, 2016
@anonimal
Moneropedia: update/finish initial Tunnel entry
b26760e 
Also, add two new "terms" entries to Encryption and Garlic-Routing

Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 19, 2016
@anonimal
Moneropedia: update Garlic-Routing/Encryption entries
d30a679 
Also, move Layered-Encryption to Garlic-Encryption

Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 19, 2016
@anonimal
Moneropedia: create Message entry and fill-in I2NP
d7c4360 
Also, update:

- Tunnel
- Encryption
- Destination

Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 20, 2016
@anonimal
Moneropedia: finish I2PControl entry
acf07a3 
Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 20, 2016
@anonimal
Moneropedia: finish Network-Database entry
27214fd 
- Add pluralized terms to Router-Info and LeaseSet
- Add self-reference in Router-Info

Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 20, 2016
@anonimal
Moneropedia: finish Garlic-Encryption
613995d 
- Resolves remaining TODO's
- Also, minor adjustments in Encryption/Garlic-Routing

Referencing:
 - monero-project/kovri#256
 - monero-project#155
@anonimal anonimal mentioned this issue Oct 20, 2016
Merged
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 20, 2016
@anonimal
Moneropedia: add Comparison page link in I2P entry
85e28fb 
Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 21, 2016
@anonimal
Moneropedia: fix typo/tense in Address-Book (thanks expez)
2253372 
Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 25, 2016
@anonimal
Moneropedia: fix typos (thanks expez)
0340302 
Referencing:
 - monero-project/kovri#256
 - monero-project#155
anonimal added a commit to anonimal/monero-site that referenced this issue Oct 25, 2016
@anonimal
Moneropedia: fix ESL typo (thanks expez)
cb90676 
Referencing:
 - monero-project/kovri#256
 - monero-project#155
fluffypony added a commit to monero-project/monero-site that referenced this issue Oct 29, 2016
@fluffypony
Merge pull request #186
6f91672 
cb90676 Moneropedia: fix ESL typo (thanks expez) (anonimal)
0340302 Moneropedia: fix typos (thanks expez) (anonimal)
2253372 Moneropedia: fix typo/tense in Address-Book (thanks expez) (anonimal)
59b605e Moneropedia: misc typo/grammar cleanup (thanks olark) (anonimal)
85e28fb Moneropedia: add Comparison page link in I2P entry (anonimal)
613995d Moneropedia: finish Garlic-Encryption (anonimal)
27214fd Moneropedia: finish Network-Database entry (anonimal)
acf07a3 Moneropedia: finish I2PControl entry (anonimal)
d7c4360 Moneropedia: create Message entry and fill-in I2NP (anonimal)
d30a679 Moneropedia: update Garlic-Routing/Encryption entries (anonimal)
b26760e Moneropedia: update/finish initial Tunnel entry (anonimal)
77d6cde Moneropedia: cleanup I2P entry (anonimal)
841f7c1 Moneropedia: resolve various unfinished entries (anonimal)
d224710 Moneropedia: update/finish initial Kovri entry (anonimal)
31af021 Moneropedia: link to Signature term in Encryption (anonimal)
2681940 Moneropedia: clarify Garlic Routing, add I2PControl (anonimal)
1af1de0 Moneropedia: add Encryption related entries (anonimal)
3761e3b Moneropedia: clarify type of I2P in Clearnet entry (anonimal)
313b069 Moneropedia: update NTCP/SSU/Transports entries (anonimal)
92b8462 Moneropedia: add Transports/SSU/NTCP (anonimal)
000e95c Moneropedia: add/update/cleanup/fix entries (anonimal)
e6661fc Moneropedia: cleanup Java-I2P entry (anonimal)
7fda45b Moneropedia: remove redundant links + fix grammar (anonimal)
bfa7a61 Moneropedia: add empty Lease-Set entry (anonimal)
ce3dc6f Moneropedia: add Router-Info and Floodfill entries (anonimal)
8af4ba7 Moneropedia: add Reseed/Network Database/Router-Info entries (anonimal)
32f4f06 Moneropedia: add Matryoshka doll comment in Garlic Routing (anonimal)
13a74cf Moneropedia: replace Onion Routing URL (anonimal)
40cebc7 Moneropedia: add wikipedia URLs for Nick/Roger (anonimal)
e8aa590 Moneropedia: add Clearnet entry (anonimal)
9e7e99b Moneropedia: edit Eepsite and Garlic Routing entries (anonimal)
9658bc6 Moneropedia: add Eepsite and Garlic Routing entries (anonimal)
e9e5257 Moneropedia: simplify address book's summary (anonimal)
e6ac646 Moneropedia: add Kovri note to I2P entry (anonimal)
87673cc Moneropedia: initial commit for monero-project/kovri#256 (anonimal)
@anonimal
Copy link
Collaborator Author

For an alpha release, I think this has been resolved.

Moneropedia entries are merged, an end-user guide is in place, and configuration files are well documented.

Ideally, there will be better documentation as we progress and a completed website but, for now, I think we have the essentials covered to satisfy this ticket.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@anonimal anonimal

Labels
documentation enhancement major
Projects
None yet
Milestone
0.1.0-alpha
Development

No branches or pull requests
1 participant
@anonimal