Hackweek 2023¶
About¶
- Hackweek 2023 announcement message.
- Hackweek 2023 milestone lists all proposals/projects/tasks.
- Tor's User Documentation Guidelines. For improvements and other feedback about the User Documentation Style Guide, please open a ticket on tpo/community/support. For fixing typos and addressing other minor issues, please feel free to directly edit the wiki page.
Projects¶
- rhatto: Onion MkDocs tryout
- roger and joydeep: Clean up and improve the user support FAQ text
- gaba: Working on the content for the developer portal (this project didn't get picked up; gaba selected other project to work on)
- nickm: Cleanups and improvements on Tor specifications
- onyinyang: Improve Lox Documentation
- gabi-250: Arti key manager documentation
- geko & juga: Fix missing documentation in network-health land (this project got picked up!)
- smith: Public documentation about project design and grant writing process (i made mild progress but mostly had other, time-sensitive tasks to deal with)
- pierov: tor-browser-build project survey
- anarcat: wiki replacement considerations (just go down to the last comment for the "presentation")
- anarcat: TPA issue templates (this project didn't get picked up)
- gaba: Public documentation about how we manage projects at Tor
- boklm: Document how to verify reproducibility of build of a mullvad/tor browser release
- donuts: design.torproject.org
- emmapeel: Tweets for the Comms team
- rhatto Onion TeX Slim enhancements (actually happened)
- rhatto / juga: Onion Reveal coding and documenting
- micah Collaborative editing:
- Proposed goals/rubric for evaluating collaborative editing tools, please provide feedback!
- Reducing the overall number of tools we have to deal with
- Integrating with our existing tools, so things are less detached
- Bridging the gap between ephemeral pads and the need for information permanence
- Achieving parity with the functionality/features that we like from existing pads
- Meets the needs of the entire organization
- Useful access restrictions (public vs. private, vandalism, etc.)
- Less fragile
- rhatto: Spell checker CI for Markdown (and maybe other) files (didn't get picked up)
- richard: Tor Browser threat documentation (didn't see this in GitLab)
Retrospective¶
What went well?¶
- We experimented with collaborative editors, that was fun!
- Lots of work on mkdocs, the wikipelago is impressive.
- This week I've already had to deal with stuff I remembered of only because the previous week I documented it.
- Writing documentation made me think about some stuff we might be doing in the wrong way and we could do better.
- Re-writing old docs made me realize:
- How some logic/software has changed.
- How some logic/software is still the same.
- Some topics we haven't really solved yet.
- Some topics I had forgotten about.
- Was pretty intense and fun!
- It makes a lot of difference to have full time allocated into a single project +1
- Really nice to do hands-on work with people I don't usually work with +1
- Using tickets to coordinate the proposals seemed to be easier than with the approach from previous years +1
What didn't work well? What were the challenges?¶
- TPA had to deal with a major emergency and couldn't complete its projects.
- Only writing docs for a few days feels more tiring than usual work to me :D (lots of details to write, they required a constatly high level of focus not to miss them).
- There is always something happening dragging me from focusing fully on the hackweek, or maybe just me procastinating hard.
- Squeezing lots of documentation demands in a single week was rewarding in the end, but very challenging and tiresome.
- There were many more existing gitlab backlog issues than we anticipated -- we had in mind to spend the week discovering new issues and opening new tickets, but we mostly spent the week working on already-filed issues.
What could we try to do differently?¶
- Defining the Hackweek date more in advance.
Questions¶
- A bit unrelated: has MkDocs a way to show as "source" markdown files in Nextcloud (no GitLab)?