Opened 2 years ago

Last modified 8 months ago

#22359 assigned enhancement

Community team and network team are constructing glossaries in parallel

Reported by: arma Owned by: emmapeel
Priority: Medium Milestone: Tor: unspecified
Component: Core Tor/Tor Version:
Severity: Normal Keywords: doc wiki glossary website tor-spec
Cc: phoul, alison, Samdney, catalyst, chelseakomlo, irl Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

https://trac.torproject.org/projects/tor/wiki/doc/community/glossary

https://gitweb.torproject.org/torspec.git/tree/glossary.txt

I wonder if there's some way to team up!

(For bonus points, there is a thing on gitweb called a glossary:
https://gitweb.torproject.org/tor-glossary.git/tree/
but it looks less advanced than either of the above two.)

Child Tickets

Change History (11)

comment:1 Changed 2 years ago by dgoulet

Milestone: Tor: unspecified

Missing milestone.

comment:2 Changed 2 years ago by nickm

Cc: catalyst chelseakomlo added
Keywords: doc wiki glossary website tor-spec added

I think it's not too nutty to have both a technical glossary and a user facing glossary -- but if that's where we are going we should probably try to get their in a coordinated way.

comment:3 Changed 2 years ago by alison

Sorry for my late arrival. Looking at these two glossaries, there is already some overlap even if the torspec one is more technical. I'm happy to work on making these two more in sync with whoever is working on the network team one.

comment:4 Changed 22 months ago by asn

Hello, took a short look at the community glossary. Great work! Here are some nitpicks:

  • bandwidth authority lemma uses the word "authority" whereas bridge authority uses the word "relay". We should decide whether we want to expose the community to the word authority or not.
  • The lemma for circuit makes it sound like a circuit requires one bridge and one relay. Perhaps we can switch it to "bridge/relay"?
  • Lemma guard is good; but not sure if the Non-exit relays can... part is useful, it seems confusing.
  • In onion address let's mention it's used by onion services.

Some missing lemmas:

  • little-t-tor is mentioned but not a lemma of its own.

comment:5 Changed 22 months ago by irl

Metrics team also has a glossary.

https://metrics.torproject.org/glossary.html

There may be overlap in terms.

comment:6 Changed 22 months ago by irl

Cc: irl added

comment:7 in reply to:  4 Changed 21 months ago by alison

Replying to asn:

Hello, took a short look at the community glossary. Great work! Here are some nitpicks:

  • bandwidth authority lemma uses the word "authority" whereas bridge authority uses the word "relay". We should decide whether we want to expose the community to the word authority or not.
  • The lemma for circuit makes it sound like a circuit requires one bridge and one relay. Perhaps we can switch it to "bridge/relay"?
  • Lemma guard is good; but not sure if the Non-exit relays can... part is useful, it seems confusing.
  • In onion address let's mention it's used by onion services.

Some missing lemmas:

  • little-t-tor is mentioned but not a lemma of its own.

Thanks asn, I made a bunch of edits based on your feedback.

comment:8 Changed 10 months ago by emmapeel

Owner: set to emmapeel
Status: newassigned

I will try to unify the different glossaries

comment:9 Changed 10 months ago by emmapeel

In the meantime I think I will add a glossaries page to the tb-manual, with all this different glossaries, so we can translate them and feed them back to transifex.

comment:10 Changed 10 months ago by emmapeel

after the community meeting this week, we have decided to have the glossary on the support portal instead.

comment:11 Changed 8 months ago by emmapeel

Ok, the glossary is at https://support.torproject.org/misc/glossary/

it needs some updates tho (Scramblesuit is there, no snowflake, many discontinued apps are mentioned like if they are still working, like Tor Messenger...)

corrections can be easily submitted by using the edit (pen) button on https://github.com/torproject/support/blob/master/content/misc/glossary/contents.lr

Note: See TracTickets for help on using tickets.