Hackweek issueshttps://gitlab.torproject.org/tpo/community/hackweek/-/issues2023-11-30T16:16:39Zhttps://gitlab.torproject.org/tpo/community/hackweek/-/issues/28Public documentation about how we manage projects at Tor2023-11-30T16:16:39ZGabagaba@torproject.orgPublic documentation about how we manage projects at Tor# About the project
* Contact: Gaba
* Chat: #tor-project on `irc.oftc.net`
* Video room: https://tor.meet.coop/gab-tph-u9q-eo0
* Meet Monday, Tuesday, Wednesday, Thursday from 12UTC to 20UTC
# Participants
- Gaba
- You?
# Summary...# About the project
* Contact: Gaba
* Chat: #tor-project on `irc.oftc.net`
* Video room: https://tor.meet.coop/gab-tph-u9q-eo0
* Meet Monday, Tuesday, Wednesday, Thursday from 12UTC to 20UTC
# Participants
- Gaba
- You?
# Summary
We have some [outdated documentation](https://gitlab.torproject.org/tpo/team/-/wikis/process/How-we-do-project-management-at-The-Tor-Project) on how we do project management at Tor. We also have templates and checklists in Nextcloud about different parts of a project's lifetime. I would like to update and expand them to be more clear and all public.
# Skills
Experience working in a sponsored project a TPO.Hackweek 2023Gabagaba@torproject.orgGabagaba@torproject.org2023-11-09https://gitlab.torproject.org/tpo/community/hackweek/-/issues/24Public documentation about project design and grant writing process2024-01-11T17:32:09Zal smithPublic documentation about project design and grant writing process# About the project
* Contact: @smith
* Chat: #tor-internal on `irc.oftc.net`
* Video room: tbd
# Participants
- @smith
- etc
# Summary
- Write a guide on the process of project design and grant proposal writing
- Publish that ...# About the project
* Contact: @smith
* Chat: #tor-internal on `irc.oftc.net`
* Video room: tbd
# Participants
- @smith
- etc
# Summary
- Write a guide on the process of project design and grant proposal writing
- Publish that guide
- Create a template spreadsheet with guidelines on how to do estimations (@gaba, any interest in helping?)
We created an [overview of the grants process in Costa Rica and presented it in an in-person session](https://gitlab.torproject.org/tpo/team/-/wikis/Meetings/2023/2023-Tor-Meeting-Costa-Rica-Wiki/overview-of-how-projects-get-funded). We can use this to create something that's easier to read, more well-resourced, and easier to find.
# Skills
- Familiarity with the project design and grant writing process, either from a team participant side (e.g., someone from the network team who has been involved grant writing before) or from the design and writing side (e.g., someone form the money machine team).
# LinksHackweek 2023al smithal smithhttps://gitlab.torproject.org/tpo/community/hackweek/-/issues/17Clean up and improve the user support FAQ text2023-11-30T16:16:39ZRoger DingledineClean up and improve the user support FAQ text# About the project
* Contact: Roger Dingledine
* Chat: #tor-www on `irc.oftc.net` / [#tor-www](https://matrix.to/#/#tor-www:matrix.org) on matrix
* Video room: https://tor.meet.coop/pav-g4m-iys-h7n (kick off meeting on Monday, 06 No...# About the project
* Contact: Roger Dingledine
* Chat: #tor-www on `irc.oftc.net` / [#tor-www](https://matrix.to/#/#tor-www:matrix.org) on matrix
* Video room: https://tor.meet.coop/pav-g4m-iys-h7n (kick off meeting on Monday, 06 November at 14 UTC)
* Pad: https://pad.riseup.net/p/improve-support-faqs-hackweek-qwjebqwjqedwqebdj
# Participants
- Roger Dingledine
- ebanam
- @gus
- you?
# Summary
Tor has a huge variety of FAQ entries on support.torproject.org, copied over from the original FAQ, the abuse FAQ, etc. When we made support.tpo, we only took some of the entries. Then we updated those over the years, but actually we have mostly left them alone -- I imagine it's hard for most individuals to decide to change one of these support entries, because they don't know who needs to buy in, or they worry that somebody else thinks it's perfect the way it is.
Let's look again at the big picture of which entries are useful, which ones are right, and whether there are any missing. The outcome will be a better support site.
# Skills
We will need people who know how to technical write, people who know what problems/questions/concerns Tor users encounter, people who know how Tor and Tor Browser work, people who have an interest in Tor comms and framing, and people who know basic html/markup. These don't all have to be the same people! :)
# LinksHackweek 2023Roger DingledineRoger Dingledinehttps://gitlab.torproject.org/tpo/community/hackweek/-/issues/13Onion MkDocs tryout2023-11-30T16:16:40ZSilvio RhattoOnion MkDocs tryout# About the project
* Contact: @rhatto
* Chat: #tor-dev on `irc.oftc.net`
* Video room: to be defined.
# Participants
- @rhatto
- @gus
- etc
# Summary
This is a proposal to try [Onion MkDocs][] for documenting things at Tor.
[Onion...# About the project
* Contact: @rhatto
* Chat: #tor-dev on `irc.oftc.net`
* Video room: to be defined.
# Participants
- @rhatto
- @gus
- etc
# Summary
This is a proposal to try [Onion MkDocs][] for documenting things at Tor.
[Onion MkDocs]: https://rhatto.pages.torproject.net/onion-mkdocs/
## Project A - Support
* [x] Provide support for people/teams that want to convert their wikis
to or have docs for their projects using [Onion MkDocs][].
* [x] Improve [Onion MkDocs][] stylesheet, plugins etc.
* [x] Improve [Onion MkDocs][] documentation.
## Project B - Convert
* [x] Convert some GitLab wikis to GitLab pages using Onion MkDocs:
* [x] Overview:
https://gitlab.torproject.org/tpo/tpa/team/-/issues/41119#note_2898441
* [x] Candidates for merge requests:
* [x] The Hackweek project itself:
https://gitlab.torproject.org/tpo/community/hackweek, with site now available
at https://tpo.pages.torproject.net/community/hackweek/
* [~] Onion Support Wiki:
https://gitlab.torproject.org/tpo/onion-services/onion-support/. To be done on Project C below.
* [x] Tor Policies repository:
https://gitlab.torproject.org/tpo/community/policies/-/issues/3
## Project C - Investigate
* [x] Investigate how Onion MkDocs could be a [TPA-RFC-38 wiki replacement (#40909) · TPA / TPA team](https://gitlab.torproject.org/tpo/tpa/team/-/issues/40909) ([tpa rfc 38 new wiki service](https://gitlab.torproject.org/tpo/tpa/team/-/wikis/policy/tpa-rfc-38-new-wiki-service)):
* [x] One approach would be to create a script that import content from some existing GitLab wikis into a single Onion MkDocs instance, to see how it would like to have a convergent "documentation integration" place. How it could be structured? Could it be easily searchable? What would be the best practices for this?
# Skills
Some knowledge in the following technologies may be needed in order to participate:
* Git/GitLab.
* Markdown.
* Basic scripting (Python, shell).
# LinksHackweek 2023Silvio RhattoSilvio Rhatto2023-11-09https://gitlab.torproject.org/tpo/community/hackweek/-/issues/36renovate-bot is too noisy here2024-03-06T20:37:59Zanarcatrenovate-bot is too noisy hereHey @rhatto
Is there a way we could tune @renovate-bot so that it doesn't generate as much noise?
It keeps reopening the same MR over and over again here. It's done 84 so far:
https://gitlab.torproject.org/tpo/community/hackweek/-/me...Hey @rhatto
Is there a way we could tune @renovate-bot so that it doesn't generate as much noise?
It keeps reopening the same MR over and over again here. It's done 84 so far:
https://gitlab.torproject.org/tpo/community/hackweek/-/merge_requests?scope=all&state=closed
The latest (https://gitlab.torproject.org/tpo/community/hackweek/-/merge_requests/131) shows that it's trying to update the submodule but, for some reason, it immediately closes the MR without actually letting us accept the change...
/cc @micahSilvio RhattoSilvio Rhattohttps://gitlab.torproject.org/tpo/community/hackweek/-/issues/35Hackweek 2023 documentation2023-11-30T17:35:12ZSilvio RhattoHackweek 2023 documentationDocument the 2023 Hackweek.Document the 2023 Hackweek.Hackweek 2023Silvio RhattoSilvio Rhatto2023-12-07https://gitlab.torproject.org/tpo/community/hackweek/-/issues/34Dockerfile for local2023-11-30T16:17:38ZSilvio RhattoDockerfile for local# About the project
* Contact: <YOUR NAME HERE>
* Chat: #tor-<FILL IN> on `irc.oftc.net`
* Video room: https://tor.meet.coop/<FILL IN>
# Participants
- <YOUR NAME HERE>
- etc
# Summary
A description of the work that you want to d...# About the project
* Contact: <YOUR NAME HERE>
* Chat: #tor-<FILL IN> on `irc.oftc.net`
* Video room: https://tor.meet.coop/<FILL IN>
# Participants
- <YOUR NAME HERE>
- etc
# Summary
A description of the work that you want to do this week.
## Project A
## Project B
## etc
# Skills
What are the skills needed for the project? For example, somebody that
knows onion services, a designer, a translator, etc.
# LinksHackweek 2023https://gitlab.torproject.org/tpo/community/hackweek/-/issues/33Add license2023-11-15T15:08:32ZSilvio RhattoAdd licenseThis project needs a copyright/copyleft license.
This is not a regular Hackweek proposal. Instead, it's is an actual task to improve it's documentation.This project needs a copyright/copyleft license.
This is not a regular Hackweek proposal. Instead, it's is an actual task to improve it's documentation.https://gitlab.torproject.org/tpo/community/hackweek/-/issues/32Improve formatting for past Hackweek documentations2024-02-13T20:06:20ZSilvio RhattoImprove formatting for past Hackweek documentationsWhile working on tpo/community/hackweek#13, Hackweek got a website: https://tpo.pages.torproject.net/community/hackweek/
Now it's way easier to browse and search for past projects, but this also exposes the need to fix formatting at som...While working on tpo/community/hackweek#13, Hackweek got a website: https://tpo.pages.torproject.net/community/hackweek/
Now it's way easier to browse and search for past projects, but this also exposes the need to fix formatting at some pages.
This ticket is about fixing the formatting for the existing docs.
This is not a regular Hackweek proposal. Instead, it's is an actual task to improve it's documentation.https://gitlab.torproject.org/tpo/community/hackweek/-/issues/31Tweets for the comms team2023-11-30T16:16:40ZemmapeelTweets for the comms team# About the project
* Contact: emmapeel
* Chat: #tor-project on `irc.oftc.net`
* Video room: https://tor.meet.coop/<FILL IN>
# Participants
- emmapeel
- pavel
# Summary
Last year we started a bank of content to tweet, with a cale...# About the project
* Contact: emmapeel
* Chat: #tor-project on `irc.oftc.net`
* Video room: https://tor.meet.coop/<FILL IN>
# Participants
- emmapeel
- pavel
# Summary
Last year we started a bank of content to tweet, with a calendar as well for important dates. This was to be put for translation, and used in our social media.
This year we did a test in weblate with a simpler format ( Here you can see the format for the Spanish translation: https://gitlab.torproject.org/tpo/translation/-/blob/social-content/es.csv?ref_type=heads ) , and we want to review last year's strings and add them to this new format component in weblate. This format is easier to use for the comms team and does not use as much resources as the previous setup with lektor and gitlabCI etc.
Last years repo: https://gitlab.torproject.org/tpo/web/social-bank/
In weblate: https://hosted.weblate.org/projects/tor/social-copy/#translations
# Skills
- We need tweets to use and translate, please add your suggestions to this ticket.
# Links
Last years repo: https://gitlab.torproject.org/tpo/web/social-bank/
In weblate: https://hosted.weblate.org/projects/tor/social-copy/#translations
New repo in gitlab: https://gitlab.torproject.org/tpo/translation/-/tree/social-content?ref_type=headsHackweek 2023emmapeelemmapeelhttps://gitlab.torproject.org/tpo/community/hackweek/-/issues/30design.torproject.org2023-12-08T21:30:56Zdonutsdesign.torproject.org# About the project
* Contact: @donuts
* Chat: **#tor-ux** on `irc.oftc.net`
* Video room: message donuts for the link
# Participants
- @donuts
- @jag
- @nicob
# Summary
The UX Team have been discussing replacing the [existing ...# About the project
* Contact: @donuts
* Chat: **#tor-ux** on `irc.oftc.net`
* Video room: message donuts for the link
# Participants
- @donuts
- @jag
- @nicob
# Summary
The UX Team have been discussing replacing the [existing styleguide](http://styleguide.torproject.org) with a new resource that's wider in scope – e.g. "design.torproject.org". In addition to updating our brand and web guidelines given their evolution over the past few years, we're also considering adding new sections to document our human-centered design principals, user research program, and overall methodology. The revised portal should serve as a central point of reference for external resources too, including for example our Figma libraries for the browser, web and VPN, and any open source design resources we use.
Given the large scope of this project, it's expected that we'll make some progress in planning the structure, content and design of the new portal – however we'll likely need to wait for a second hackweek or future funding opportunity to complete the implementation.
**Hackweek goals:**
- [x] Site map
- [x] Some content planning/development
- [ ] Figma prototype
- [ ] Basic HTML templates (stretch goal)
# Requirements
Institutional knowledge:
- Direct knowledge of the Tor Project's brand, design systems, user experience and/or user research practices.
- Or the ability to communicate your needs as a consumer of this documentation.
Technical skills:
- Graphic and/or web design (required)
- Front-end development (optional)
- Experience with lektor (optional)
# Links
Existing documentation:
- [Tor Project Styleguide](https://styleguide.torproject.org)
- [Community / User Research](https://community.torproject.org/user-research/)
- [User Research repo](https://gitlab.torproject.org/tpo/ux/research)
- [Firefox Acorn](https://acorn.firefox.com/latest/acorn-aRSAh0Sp) (external)
Design libraries:
- [Tor Browser for Desktop](https://www.figma.com/file/RtZ0fqkNMRc7GOjK3FLclz/Tor-Browser-for-Desktop?type=design&node-id=611%3A55&mode=design&t=1YIBBFxWnpmQUHwP-1)
- [Tor Browser for Android](https://www.figma.com/file/LaU3qFpem2xQOfBF6MEYVR/Tor-Browser-for-Android?type=design&node-id=611%3A55&mode=design&t=mjkrcP2LegGQLM8K-1)
- [Icons & Illustrations](https://www.figma.com/file/sd4yASXsToxFECsraTlAsw/Icons-%26-illustrations?type=design&node-id=0%3A1&mode=design&t=jGmz3Uwj5OmdsGoK-1)Hackweek 2023donutsdonutshttps://gitlab.torproject.org/tpo/community/hackweek/-/issues/29Document how to verify reproducibility of build of a mullvad/tor browser release2023-11-30T16:16:39ZboklmDocument how to verify reproducibility of build of a mullvad/tor browser release# About the project
* Contact: @boklm
* Chat: #tor-browser-dev on `irc.oftc.net`
* Video room: no
# Participants
- @boklm
# Summary
I think many users don't know that our builds are reproducible, or how they can rebuild to verify...# About the project
* Contact: @boklm
* Chat: #tor-browser-dev on `irc.oftc.net`
* Video room: no
# Participants
- @boklm
# Summary
I think many users don't know that our builds are reproducible, or how they can rebuild to verify that they get a matching build.
We could generate a `reproducible-build.txt` file in the release directory containing the following informations:
* which git repository to clone
* which commit to checkout
* which command to use to start the build
* which sha256sums to expect after the build finished
* how to remove embedded signatures from exe and mar files we publish to check that they match the unsigned build
# Skills
Need to know how to build Tor Browser.
# Links
* tpo/applications/tor-browser-build#40997Hackweek 2023boklmboklmhttps://gitlab.torproject.org/tpo/community/hackweek/-/issues/27TPA issue templates2023-11-30T16:16:39ZanarcatTPA issue templates# About the project
* Contact: @anarcat
* Chat: #tor-admin on `irc.oftc.net`
* Video room: https://tor.meet.coop/ana-amp-2kq-z2o
# Participants
- @anarcat
# Summary
An ancient ticket in the TPA issue tracker has been found, and i...# About the project
* Contact: @anarcat
* Chat: #tor-admin on `irc.oftc.net`
* Video room: https://tor.meet.coop/ana-amp-2kq-z2o
# Participants
- @anarcat
# Summary
An ancient ticket in the TPA issue tracker has been found, and it is full of precious metals, behold https://gitlab.torproject.org/tpo/tpa/team/-/issues/29398. The idea is that many (MANY) tickets issued in TPA often require the same basic data. Want a server? How big? who's team? Your PGP key expired? Please ship the key, etc. We waste an inordinate amount of time collecting that information when people open new issues.
The task here is to setup those templates in the TPA issue tracker. The twist is that right now the TPA project doesn't have any code at all: it's a "wiki only" GitLab project, and the code is instead in the tpo/tpa/wiki-replica project, mirrored into the tpo/tpa/team wiki, which shows up as the frontpage for the project. We need to find a way to do this transition cleanly, probably by moving wiki-replica directly into tpo/tpa/team (in which case we lose the homepage) or some other sheninagan.
# Skills
Some experience with GitLab is important. Probably relevant only to TPA people, but other contributors are of course welcome!
# Links
* https://gitlab.torproject.org/tpo/tpa/team/-/issues/29398
* https://gitlab.torproject.org/tpo/tpa/wiki-replica/
* https://gitlab.torproject.org/tpo/tpa/team/Hackweek 2023anarcatanarcathttps://gitlab.torproject.org/tpo/community/hackweek/-/issues/26wiki replacement considerations2023-11-30T16:16:40Zanarcatwiki replacement considerations# About the project
* Contact: anarcat
* Chat: #tor-admin on `irc.oftc.net`
* Video room: https://tor.meet.coop/ana-amp-2kq-z2o
# Participants
- @anarcat
- @shelikhoo
# Summary
[TPA-RFC-38: Wiki replacement](https://gitlab.torproj...# About the project
* Contact: anarcat
* Chat: #tor-admin on `irc.oftc.net`
* Video room: https://tor.meet.coop/ana-amp-2kq-z2o
# Participants
- @anarcat
- @shelikhoo
# Summary
[TPA-RFC-38: Wiki replacement](https://gitlab.torproject.org/tpo/tpa/team/-/wikis/policy/tpa-rfc-38-new-wiki-service) is a draft from TPA aiming at reviewing whether or not to replace the current GitLab wiki(s) by something else. It's mostly stalled, so let's see if we can move it forward a nudge.
Let's review the requirements to see if they cover what we need and what we want to accomplish. I particularly want to discuss which content we intend to throw "in the wiki" and whether a wiki is the appropriate tool for this. I particularly do *not* feel like it's a good tool for technical team to document their software projects, where alternatives like mdbook, sphinx or mkdocs seem better suited (see the recent torspec change for example).
It's unclear how this should be organized. In Costa Rica we've had an informal discussion about this which was useful, maybe having a BBB call or two to shake things up could move this ahead?
# Skills
Everyone from the community is welcome to join the discussion.
# Links
* https://gitlab.torproject.org/tpo/tpa/team/-/wikis/policy/tpa-rfc-38-new-wiki-service
* https://gitlab.torproject.org/tpo/tpa/team/-/issues/40909Hackweek 2023anarcatanarcathttps://gitlab.torproject.org/tpo/community/hackweek/-/issues/25tor-browser-build project survey2023-12-01T14:28:56ZPier Angelo Vendrametor-browser-build project survey# About the project
* Contact: @pierov
* Chat: #tor-browser-dev on `irc.oftc.net`
* Video room: nope
# Participants
- suggested: apps team members and other people who regularly use tor-browser-build or curious about it
- @boklm
...# About the project
* Contact: @pierov
* Chat: #tor-browser-dev on `irc.oftc.net`
* Video room: nope
# Participants
- suggested: apps team members and other people who regularly use tor-browser-build or curious about it
- @boklm
# Summary
We have 120 projects in tor-browser-build.
Understand why we have some them is easy (e.g., Firefox), but some other are platform-dependent (e.g., the shenanigans that macOS signing needs), some other are Namecoin dependencies.
## Dependencies graph
It'd be great to create a graph with all the dependencies.
Hopefully it should contain just a single connected component (`browser`/`release`), or a few additional components that make sense to have (e.g., signing tools).
If we find components that don't make sense to have, we should then purge them from `tor-browser-build` (e.g., dependencies that aren't needed anymore and recursive dependencies).
I'd expect the graph to be directed and cyclical (some components depend on themselves with a different target).
So, we might find also some projects/nodes that just depend on other nodes, without being a dependency for anything.
We might want to purge them as well.
## Project readmes
At the moment, each project is required to have a `config` file, but most have also a `build` file.
It'd be great if we added a `README.md` (or something similar) to each project, to explain:
- what it is
- why we have it
- what we do here if it isn't trivial (e.g., for `browser`) and/or caveats of the build process (e.g., we have to do these additional steps because we cross compile, or we have to do also this for reproducible purposes)
- references (e.g., link to the website, when we follow Mozilla's build script, a reference to these build scripts, or known issues, such as NSIS requiring to be built with GCC).
# Skills
Know tor-browser-build (well, this documentation project might help knowing it more).
# LinksHackweek 2023Pier Angelo VendramePier Angelo Vendramehttps://gitlab.torproject.org/tpo/community/hackweek/-/issues/23Fix missing documentation in network-health land2023-11-30T16:16:40ZGeorg KoppenFix missing documentation in network-health land# About the project
* Contact: @gk
* Chat: #tor-dev> on `irc.oftc.net`
* Video room: non yet
# Participants
- @gk
- @juga
- etc
# Summary
Fix missing documentation in network-health land
## Project A
We'll go over the open ti...# About the project
* Contact: @gk
* Chat: #tor-dev> on `irc.oftc.net`
* Video room: non yet
# Participants
- @gk
- @juga
- etc
# Summary
Fix missing documentation in network-health land
## Project A
We'll go over the open tickets with the `Documentation` label in network health land try to prioritize them and then fix as many of them as possible (starting with the most important ones). Alternatively, it's fine if folks just pick up any of those tickets and fix them. :smile:
# Skills
No special skillz
https://gitlab.torproject.org/tpo/network-health/team/-/issues/201 might be related to https://gitlab.torproject.org/tpo/community/hackweek/-/issues/19
https://gitlab.torproject.org/tpo/network-health/bandwidth-authorities/-/issues/2 is related to other security guidelines
# Links
https://gitlab.torproject.org/groups/tpo/network-health/-/issues/?sort=created_date&state=opened&label_name%5B%5D=Documentation&first_page_size=20
https://gitlab.torproject.org/groups/tpo/network-health/-/issues/?sort=created_date&state=opened&label_name%5B%5D=Docshackathon&assignee_username%5B%5D=juga&first_page_size=100
Update: added juga, tentative issues and other teams' related issuesHackweek 2023Georg KoppenGeorg Koppenhttps://gitlab.torproject.org/tpo/community/hackweek/-/issues/22Arti key manager documentation2023-11-30T16:16:39Zgabi-250Arti key manager documentation# About the project
* Contact: @gabi-250
* Chat: #tor-dev on `irc.oftc.net`
* Video room: TBD
# Participants
- @gabi-250
- etc
# Summary
The Arti team has been implementing a key management backend for handling the
various keys a...# About the project
* Contact: @gabi-250
* Chat: #tor-dev on `irc.oftc.net`
* Video room: TBD
# Participants
- @gabi-250
- etc
# Summary
The Arti team has been implementing a key management backend for handling the
various keys and certificates required by Arti to operate (see
https://gitlab.torproject.org/tpo/core/arti/-/issues/728 for a brief
overview).
The projects I'm proposing here aim to improve the various bits of documentation related to key
management in Arti.
## Project A: Set up a protocol name registry
The main (and currently only) Arti key store is an on-disk store that stores
keys in OpenSSH key format.
Some of the key types we need to support don't have a
predefined SSH public key [algorithm name], so we've had to
define several custom SSH algorithm names (for example, we have a custom
algorithm name for x25519 keys, which don't have a predefined algorithm name).
See
https://gitlab.torproject.org/tpo/core/arti/-/issues/936 and
https://gitlab.torproject.org/tpo/core/arti/-/issues/1049 for more details.
As per [RFC4251 § 6], our custom ssh algorithm names use the
`<something@subdomain.torproject.org>` format.
**In order to manage the local
namespacing of our (Tor Project's) custom SSH algorithm names, we will need a
protocol name registry**. This protocol name registry will live in
[torspec](https://gitlab.torproject.org/tpo/core/torspec) repo.
This [comment] lists the algorithm strings that will need to be documented, and
can be used as a starting point for this project.
## Project B: Improve documentation in the tor-keymgr crate
I think the documentation of the `tor-keymgr` crate could use some improvements:
* the `ArtiNativeKeystore` docs are very sparse (i.e. we should at least
document the key format it's using)
* it would be nice to have some docs explaining how to implement a custom key
store
* it would be nice to have some docs explaining how to mock a `Keystore`
* etc
## Project C: Document Arti's future key management CLI
We will eventually want to have a CLI for managing keys in Arti.
We should document various use-cases for it, and the corresponding command
invocation (i.e. its arguments).
(This may or may not be within the scope of Hackweek).
# Skills
* Git/GitLab.
* Markdown.
* Writing documentation.
Project A requires some knowledge (or willingness to learn) about
the OpenSSH key format used for keys stored in the Arti key store.
Project B requires some knowledge (or willingness to learn) about
the internals of Arti's key manager/key store implementations.
# Links
* a sketch of the [key manager/keystore
APIs](https://gitlab.torproject.org/tpo/core/arti/-/blob/8598f8902ed76d3302701934b86bb54b74a4326f/doc/dev/notes/key-management.md)
we have in Arti
* the currently supported key types are listed
[here](https://gitlab.torproject.org/tpo/core/arti/-/blob/8598f8902ed76d3302701934b86bb54b74a4326f/doc/dev/notes/key-management-paths.md)
* a more comprehensive (but somewhat out of date) list of keys that we want to
support can be found
[here](https://gitlab.torproject.org/tpo/core/arti/-/blob/8598f8902ed76d3302701934b86bb54b74a4326f/doc/dev/notes/key-management-keygen.md)
[algorithm name]: https://www.iana.org/assignments/ssh-parameters/ssh-parameters.xhtml#ssh-parameters-19
[RFC4251 § 6]: https://www.rfc-editor.org/rfc/rfc4251.html#section-6
[comment]: https://gitlab.torproject.org/tpo/core/arti/-/blob/8598f8902ed76d3302701934b86bb54b74a4326f/crates/tor-keymgr/src/key_type/ssh.rs#L22-91Hackweek 2023gabi-250gabi-250https://gitlab.torproject.org/tpo/community/hackweek/-/issues/21Spell checker CI for Markdown (and maybe other) files2023-11-30T16:16:39ZSilvio RhattoSpell checker CI for Markdown (and maybe other) files# About the project
* Contact: @rhatto
* Chat: #tor-dev on `irc.oftc.net`
* Video room: to be defined.
# Participants
- @rhatto (I'm proposing more than one project to the 2023 Hackweek, so I might end up participating in just one, de...# About the project
* Contact: @rhatto
* Chat: #tor-dev on `irc.oftc.net`
* Video room: to be defined.
# Participants
- @rhatto (I'm proposing more than one project to the 2023 Hackweek, so I might end up participating in just one, depending on other people interest in participate)
- etc
# Summary
This is a proposal to write a spell checking [GitLab CI/CD](https://about.gitlab.com/topics/ci-cd/) job (or a bot) to look for typos in Markdown files (and maybe other types).
## Project A - Writing
The first project in this proposal would be to actually write the spell checking routine.
Some existing solutions that can be evaluated and used, or being just a source of inspiration:
* [R2Devops - codespell](https://r2devops.io/marketplace/gitlab/r2devops/hub/codespell)
* [codespell-project/codespell: check code for common misspellings](https://github.com/codespell-project/codespell)
* [check-spelling/check-spelling: Spelling checker action to check spelling in repositories / pull requests / commits](https://github.com/check-spelling/check-spelling)
* [betrybe/code-spell-checker-action](https://github.com/betrybe/code-spell-checker-action)
* [CSpell | A Spell Checker for Code!](http://cspell.org/)
* [Documentation for Spelling - spell checker for CI!](https://spelling-dev.readthedocs.io/en/latest/)
It may also be important to find a way to reduce false positives.
## Project B - Integrating
In this project, the spell checker would be integrated into the following projects:
* [Onion MkDocs](https://rhatto.pages.torproject.net/onion-mkdocs/).
* [Onion TeX Slim](https://gitlab.torproject.org/rhatto/onion-tex-slim).
* [Onion Reveal](https://gitlab.torproject.org/tpo/community/hackweek/-/issues/15) (if it actually exists).
* ... and also in some repositories using these things (like [The Onion Plan](https://tpo.pages.torproject.net/onion-services/onionplan/))!
## Project C - Documenting
This project is about documenting how to use the spell checker in a repository.
# Skills
Some knowledge in the following technologies may be needed in order to participate:
* Git/GitLab CI.
* Markdown.
* Writing documentation.
* Basic scripting (Python, shell).Hackweek 2023Silvio RhattoSilvio Rhatto2023-11-09https://gitlab.torproject.org/tpo/community/hackweek/-/issues/20Improve Lox Documentation2023-11-30T16:16:40ZonyinyangImprove Lox Documentation# About the project
* Contact: @onyinyang
* Chat: #tor-anticensorship on `irc.oftc.net`
* Video room: to be defined.
# Participants
- @onyinyang
- anyone else that wants to join
# Summary
This is about enhancing the documentation...# About the project
* Contact: @onyinyang
* Chat: #tor-anticensorship on `irc.oftc.net`
* Video room: to be defined.
# Participants
- @onyinyang
- anyone else that wants to join
# Summary
This is about enhancing the documentation for [Lox](https://gitlab.torproject.org/tpo/anti-censorship/lox). Lox will be deployed in alpha early next year. We currently have a Wiki as well as a Lox workspace with some incomplete documentation. Now that development towards the alpha is nearing completion, it would be a good time to make sure that documentation is more comprehensive and up to date.
## Project A - Update workspace repository descriptions, build instructions, etc.
* [x] Ensure that each repository in the Lox workspace has an up to date README with comprehensive build/deployment instructions and other information that a user/developer might need
* [x] Ensure that each Lox crate is prepared for publication on `crates.io`
## Project B - Update Lox wiki to provide a better overview of Lox as well as each of the interacting systems and how they work together
* [ ] Ensure that the Lox wiki has a comprehensive overview of Lox as well as the related systems it interacts with
* [ ] Include documentation for users based on [browser UI](https://gitlab.torproject.org/tpo/applications/tor-browser/-/issues/42036#note_2960089)
# Skills
What are the skills needed for the project:
* Knowledge of Lox
# LinksHackweek 2023onyinyangonyinyanghttps://gitlab.torproject.org/tpo/community/hackweek/-/issues/19Cleanups and improvements on Tor specifications2023-11-30T16:16:39ZNick MathewsonCleanups and improvements on Tor specifications# About the project
* Contact: Nick Mathewson
* Chat: #tor-dev on `irc.oftc.net`
* Video room: <https://tor.meet.coop/nic-u9t-t6q-hmy>
# Participants
- Nick Mathewson
- etc
# Summary
We [recently][prop345] migrated our [protocol ...# About the project
* Contact: Nick Mathewson
* Chat: #tor-dev on `irc.oftc.net`
* Video room: <https://tor.meet.coop/nic-u9t-t6q-hmy>
# Participants
- Nick Mathewson
- etc
# Summary
We [recently][prop345] migrated our [protocol specifications] to [mdbook], in
preparation for a larger round of revisions and improvements.
This week, we'll be working on the follow-ups from that transition,
and other general improvements on the specifications.
## Project A: Simple mdbook-related followups
Our conversion process was largely a mechanical one, and there
is substantial opportunity for improving its results.
This might take the form of:
- Looking for instances of \`\`\` blocks that can instead be
formatted better as tables, indented text, or some other
kind of information.
- Looking for occurrences of "See section X.Y.Z above" or similar
text that can be turned into links.
- Looking over our existing links, and making sure that they are well
considred.
- Looking for misformatted text in the output, and correcting the
markdown that generated it.
- Making the resulting documentation better fit our themes and style guidelines.
This will not be a purely mechanical process. You will need to make
sure that you understand what you are reading well enough to be sure
that you aren't changing its meaning, that your links really are going
to the intended text, and so on.
## Project B: Revisions for clarity and consistency
This year marks the twentieth anniversary of our [first attempt] at a
protocol specification. Over the years, as our protocol grew,and as
our terminology evolved, we have revised and extended the specs bit
by bit, but seldom had a chance to consider their readability as a whole.
With this project, we will be looking for was to improve our
specifications as a whole, by fixing issues like:
- Inconsistent or outdated terminology
- Missing explanations
- Material without sensible motivation
- Lack of distinction between specification and analysis
- Illogical ordering and division of chapters
- Obscure writing
- Lack of overall introductions
- Historical notations of limited relevance
- Outdated notes about years-unsupported versions of Tor, or
plans from the distant past.
Again, this cannot be a mechanical process: you don't need to be an
_expert_ in the Tor protocols to work on this, but also you can't just
search and replace old terms for new ones, or rewrite text without
taking time to understand what it means.
# Skills
Before you begin, you should make sure that you can use git, edit
markdown, and make merge requests on <https://gitlab.torproject.org/>.
It would also be a good idea to make sure that you can build the
HTML-rendered spec website locally. There is a [script to do
that][build_html] in the specification repository; you will need
to make sure that you have Python and mdbook installed.
Finally, you should be comfortable reading and writing specification
documents of this type, and you should have some idea of how Tor
works.
# Links
[prop345]: https://spec.torproject.org/proposals/345-specs-in-mdbook.html
[protocol specifications]: https://spec.torproject.org/
[mdbook]: https://rust-lang.github.io/mdBook/
[build_html]: https://gitlab.torproject.org/tpo/core/torspec/-/blob/main/bin/build_html.sh?ref_type=heads
[first attempt]: https://gitlab.torproject.org/tpo/core/tor/-/commit/858c611573167adb328e2359ad0c4a866070964eHackweek 2023Nick MathewsonNick Mathewson