The Tor Project issueshttps://gitlab.torproject.org/groups/tpo/-/issues2023-11-30T16:16:40Zhttps://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/web/blog/-/issues/40066Update CoC link2023-10-25T21:24:35ZGusUpdate CoC linkTor Code of Conduct document moved from gitweb to gitlab (https://gitlab.torproject.org/tpo/community/policies/-/blob/master/code_of_conduct.txt?ref_type=heads).
We need to change the link: https://gitlab.torproject.org/tpo/web/blog/-/b...Tor Code of Conduct document moved from gitweb to gitlab (https://gitlab.torproject.org/tpo/community/policies/-/blob/master/code_of_conduct.txt?ref_type=heads).
We need to change the link: https://gitlab.torproject.org/tpo/web/blog/-/blob/main/templates/macros/blog.html#L87Jérôme Charaouilavamind@torproject.orgJérôme Charaouilavamind@torproject.orghttps://gitlab.torproject.org/tpo/web/community/-/issues/327Clienth Authorization might need a full restart2023-11-23T15:37:47ZSilvio RhattoClienth Authorization might need a full restartWhen updating [Client Authorization][] keys, seems like a `systemctl reload tor` won't update the configuration (as it's currently documented), and a full restart is required.
Needs more testing to confirm if that's the case, and fix th...When updating [Client Authorization][] keys, seems like a `systemctl reload tor` won't update the configuration (as it's currently documented), and a full restart is required.
Needs more testing to confirm if that's the case, and fix the documentation if needed (or fill a bug upstream if it's expected that a `reload` should trigger a config update in this case).
[Client Authorization]: https://community.torproject.org/onion-services/advanced/client-auth/https://gitlab.torproject.org/tpo/onion-services/oniongroove/-/issues/5Vendorize Onion MkDocs2024-03-27T21:47:27ZSilvio RhattoVendorize Onion MkDocsVendorize [Onion MkDocs](https://gitlab.torproject.org/rhatto/onion-mkdocs), so it's easier to retrieve updates.Vendorize [Onion MkDocs](https://gitlab.torproject.org/rhatto/onion-mkdocs), so it's easier to retrieve updates.Oniongroove 0.1.0Silvio RhattoSilvio Rhatto2024-05-16https://gitlab.torproject.org/tpo/onion-services/onionbalance/-/issues/25Onionbalance Security Analysis2024-01-30T12:28:21ZSilvio RhattoOnionbalance Security AnalysisWrite a quick threat model / security analysis for Onionbalance, stating what it brings (or does not bring) in terms of security.
One good aspect to highlight is that it can offer a practical solution to reduce the attack surface in the...Write a quick threat model / security analysis for Onionbalance, stating what it brings (or does not bring) in terms of security.
One good aspect to highlight is that it can offer a practical solution to reduce the attack surface in the long-term .onion identity key, since only the frontend/publish nodes need to have access to it. So Onionbalance is not just about load balancing, but also separation of concerns/isolation. And until offline keys is supported, that's the best and easier approach to reduce the attack surface on these keys.
The [Vanguards' security analysis][] may be a good source of inspiration for such document, in terms of structure and content.
[Vanguards' security analysis]: https://github.com/mikeperry-tor/vanguards/blob/master/README_SECURITY.mdOnionbalance 0.2.3https://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 Mathewsonhttps://gitlab.torproject.org/tpo/web/manual/-/issues/151Update Tor Browser binary's naming scheme2024-03-12T12:53:53Zebanamebanam@torproject.orgUpdate Tor Browser binary's naming schemeWith Tor Browser 13 (https://gitlab.torproject.org/tpo/applications/tor-browser-build/-/issues/40829), we have a specific naming scheme for Tor Browser binaries. This ticket is to track and update all instances of it in the Manual.With Tor Browser 13 (https://gitlab.torproject.org/tpo/applications/tor-browser-build/-/issues/40829), we have a specific naming scheme for Tor Browser binaries. This ticket is to track and update all instances of it in the Manual.ebanamebanam@torproject.orgebanamebanam@torproject.orghttps://gitlab.torproject.org/tpo/web/support/-/issues/335Update Tor Browser binary's naming scheme2024-03-12T18:03:49Zebanamebanam@torproject.orgUpdate Tor Browser binary's naming schemeWith Tor Browser 13 (https://gitlab.torproject.org/tpo/applications/tor-browser-build/-/issues/40829), we have a specific naming scheme for Tor Browser binaries. This ticket is to track and update all instances of it in the Support Portal.With Tor Browser 13 (https://gitlab.torproject.org/tpo/applications/tor-browser-build/-/issues/40829), we have a specific naming scheme for Tor Browser binaries. This ticket is to track and update all instances of it in the Support Portal.ebanamebanam@torproject.orgebanamebanam@torproject.orghttps://gitlab.torproject.org/tpo/web/community/-/issues/326Clarify the section about using privileged ports2023-10-16T16:36:05ZharpiaClarify the section about using privileged ports<!--
* Use this issue template for suggesting new docs or updates to existing docs.
-->
### Problem to solve
In step number 5, we have instructions for using privileged ports
> If you decide to use a fixed obfs4 port smaller than 1024....<!--
* Use this issue template for suggesting new docs or updates to existing docs.
-->
### Problem to solve
In step number 5, we have instructions for using privileged ports
> If you decide to use a fixed obfs4 port smaller than 1024...
And it continues with
> To work around systemd hardening...
which is still talking about privileged ports. But visually, these paragraphs don't seem to be related. See how it renders:
![Screenshot_2023-10-14_at_21-16-06_Tor_Project_Debian___Ubuntu](/uploads/bd8165250bc43d9c9ee4f98b651c0f36/Screenshot_2023-10-14_at_21-16-06_Tor_Project_Debian___Ubuntu.png)
I'm not using a privileged port, but because of the structure of this document, for a while I thought I had to configure systemd!
### Further details
Link to the page: https://community.torproject.org/relay/setup/bridge/debian-ubuntu/
Link to the source: https://gitlab.torproject.org/tpo/web/community/-/blob/main/content/relay/setup/bridge/debian-ubuntu/contents.lr
I'm running Firefox 118.0.2 (64-bit) on Linux
### Proposal
<!-- Further specifics for how can we solve the problem. -->
I couldn't edit the page myself, as I don't recognize the syntax of these files. It looks a bit like Markdown, but it's different.GusGushttps://gitlab.torproject.org/tpo/web/community/-/issues/325Which fingerprint?2024-02-05T20:09:19ZharpiaWhich fingerprint?<!--
* Use this issue template for suggesting new docs or updates to existing docs.
-->
### Problem to solve
<!-- Include the following detail as necessary:
-->
I think this paragraph needs clarification:
> You'll need to replace `<I...<!--
* Use this issue template for suggesting new docs or updates to existing docs.
-->
### Problem to solve
<!-- Include the following detail as necessary:
-->
I think this paragraph needs clarification:
> You'll need to replace `<IP ADDRESS>`, `<PORT>`, and `<FINGERPRINT>` with the actual values, which you can find in the tor log. Make sure to use `<FINGERPRINT>`, not `<HASHED FINGERPRINT>`; and that `<PORT>` is the obfs4 port you chose - and not the OR port.
The Tor logs list 3 different fingerprints.
```
Your Tor server's identity key fingerprint <fingerprint>
Your Tor bridge's hashed identity key fingerprint <fingerprint>
Your Tor server's identity key ed25519 fingerprint <fingerprint>
```
### Further details
- Link to the page: https://gitlab.torproject.org/tpo/web/community/-/blob/main/content/relay/setup/bridge/post-install/contents.lr
### Proposal
<!-- Further specifics for how can we solve the problem. -->
Correct me if I'm wrong - I think the correct fingerprint is the first one, "your Tor server identity key". This is how I would rewrite it:
> Make sure to use your Tor server's identity key fingerprint, not the hashed bridge key or the ed25519 key;GusGushttps://gitlab.torproject.org/tpo/community/l10n/-/issues/40120Fix text direction for commands in RTL pages2023-11-09T19:11:36ZemmapeelFix text direction for commands in RTL pagesWhen we add latin characters for commands in RTL pages, they are identified as being LTR and displayed almost correctly.
Almost, because when they have neutral-direction characters, those are still layered as RTL, and so, many commands ...When we add latin characters for commands in RTL pages, they are identified as being LTR and displayed almost correctly.
Almost, because when they have neutral-direction characters, those are still layered as RTL, and so, many commands are broken and will not work if copied by the users:
![Screenshot_from_2023-10-13_10-57-49](/uploads/4993334ae16eaa0e064423d9e2e6947d/Screenshot_from_2023-10-13_10-57-49.png) ![Screenshot_from_2023-10-13_10-57-21](/uploads/d78dd206ff6c4730e9d55fb5d8b90069/Screenshot_from_2023-10-13_10-57-21.png)
If we insert UTF-8 embedded direction characters, many times they are removed because they are fishy (for example, they will be removed from the page if you edit it in the gitlab editor).
So I think we can try to solve this by giving the `<code>` style a forced LTR direction. This will probably make sense to do in lego, but I will try on one lektor before to see if it works.Jérôme Charaouilavamind@torproject.orgJérôme Charaouilavamind@torproject.orghttps://gitlab.torproject.org/tpo/community/hackweek/-/issues/18Working on the content for the developer portal2023-11-30T16:16:39ZGabagaba@torproject.orgWorking on the content for the developer portal# About the project
* Contact: @gaba
* Chat: #tor-dev 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-dev 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
The [developer portal](https://gitlab.torproject.org/tpo/web/dev/) has been on the back waiting for some time to get completed. At the beginning of this year Ura.Design worked on a [site/design](https://gitlab.torproject.org/tpo/web/dev/-/issues/6) for it. This is a project to get the content into the site and reviewing the information architecture.
## Project A : Get content into the portal
The content that we are planning to have in this portal is all over the place in repositories and wikis. With this project I will move the content to the dev portal, review the information architecture and organize the work that needs to happen next.
# Skills
- Gitlab
- Writing documentation
- MarkdownHackweek 2023Gabagaba@torproject.orgGabagaba@torproject.org2023-11-09https://gitlab.torproject.org/tpo/network-health/team/-/issues/331Clean up and merge Onionoo documentation2023-10-04T10:37:59ZGeorg KoppenClean up and merge Onionoo documentationWe currently have https://gitlab.torproject.org/tpo/network-health/team/-/wikis/metrics/onionoo/home and https://gitlab.torproject.org/tpo/network-health/team/-/wikis/metrics/onionoo/onionoo-ops with overlapping content. We should clean ...We currently have https://gitlab.torproject.org/tpo/network-health/team/-/wikis/metrics/onionoo/home and https://gitlab.torproject.org/tpo/network-health/team/-/wikis/metrics/onionoo/onionoo-ops with overlapping content. We should clean that up and merge the content where needed.
/cc @hirohttps://gitlab.torproject.org/tpo/community/hackweek/-/issues/16Collaborative editing2023-11-30T16:16:40ZSilvio RhattoCollaborative editing# About the project
* Contact: @rhatto
* Chat: #tor-dev on `irc.oftc.net`
* Video room: to be defined.
# Participants
- @meskio
- @rhatto (I'm looking for someone to be the new maintainer/coordinator/asignee for this proposal, as I ma...# About the project
* Contact: @rhatto
* Chat: #tor-dev on `irc.oftc.net`
* Video room: to be defined.
# Participants
- @meskio
- @rhatto (I'm looking for someone to be the new maintainer/coordinator/asignee for this proposal, as I may participate only marginally on it)
- @micah
- @shelikhoo (Partially)
# Summary
This is about enhancing ways we deal with [Etherpads](https://etherpad.org/).
## Project A - Nextcloud collaborative editor
* [x] Try the Nextcloud collaborative editor as an attempt at reducing the number of external tools we have to deal with.
## Project B - Etherpad
* [x] Etherpad archival utility/GitLab bot (as ticket comments, merge requests etc). Use case: add pad links into the ticket description, and the bot will act regularly, submitting changes somewhere. Maybe this already exists? We may also try to expand this use case for other document sources/platforms.
* [ ] Investigate the possibility to run our own etherpad, and not use the pad cleanup that Riseup does, and then the pads can be integrated with Nextcloud.
## Project C - CryptPad
* [x] Etherpad may be winding down development, and we should re-consider [CryptPad](https://cryptpad.fr/), which has a number of document management utilities bundled with it.
## Project D - HedgeDoc
* [ ] Try [HedgeDoc](https://hedgedoc.org/), "an open-source, web-based, self-hosted, collaborative markdown editor".
# Skills
What are the skills needed for the project:
* Not sure yet! Maybe no specific skills needed.
* Etherpad autosaving may depend on the knowledge needed to create GitLab bots and other scripts.
# LinksHackweek 2023micahmicah@torproject.orgmicahmicah@torproject.org2023-11-09https://gitlab.torproject.org/tpo/network-health/metrics/website/-/issues/40098Update and improve frac calculation documentation on reproducible-metrics web...2024-03-27T09:41:42ZGeorg KoppenUpdate and improve frac calculation documentation on reproducible-metrics website@dcf [noted a while back in a thread on tor-dev@](https://lists.torproject.org/pipermail/tor-dev/2022-April/014724.html) that our `frac` calculation is both hard to understand and wrong as stated on our reproducible-metrics website. We s...@dcf [noted a while back in a thread on tor-dev@](https://lists.torproject.org/pipermail/tor-dev/2022-April/014724.html) that our `frac` calculation is both hard to understand and wrong as stated on our reproducible-metrics website. We should fix both. FWIW: I think this would be a valuable thing to do during our documentation hackweek later this year in November.https://gitlab.torproject.org/tpo/community/hackweek/-/issues/15Onion Reveal coding and documenting2023-12-11T09:46:02ZSilvio RhattoOnion Reveal coding and documenting# 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 write a [reveal.js](https://revealjs.com/) compiler similar...# 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 write a [reveal.js](https://revealjs.com/) compiler similar to [Onion TeX Slim][].
[Onion TeX Slim]: https://gitlab.torproject.org/rhatto/onion-tex-slim
## Project A - Writing
The first project in this proposal would be to actually write Onion Reveal. This software could work like this:
* [x] Use a Makefile/script target that traverses a folder looking for `.md` files.
* [x] Then it would build the HTML slides using a pandoc reveal template.
* [x] With CI/CD for automation, in a way that's easy to integrate into existing projects.
* [x] Localization support.
* [ ] With support for QR code generation, so it's easy to embed QR codes into slides.
Examples:
* [Files · main · The Tor Project / Web / community · GitLab](https://gitlab.torproject.org/tpo/web/community/-/tree/main)
* [templates/slideshow.html · main · The Tor Project / Web / community](https://gitlab.torproject.org/tpo/web/community/-/blob/main/templates/slideshow.html)
* [models/slideshow.ini · main · The Tor Project / Web / community](https://gitlab.torproject.org/tpo/web/community/-/blob/main/models/slideshow.ini)
* [assets/static/revealjs/dist/theme/tor.css · community](https://gitlab.torproject.org/tpo/web/community/-/blob/main/assets/static/revealjs/dist/theme/tor.css)
* [Helping Survivors of Domestic Violence](https://community.torproject.org/training/resources/helping-survivors/)
## Project B - Trying
* [x] Use this project to build some presentations:
* [x] Tor Training materials: tpo/community/training#122.
Related issues:
* [Make Tor training slides compatible with Reveal JS format (#268) · community](https://gitlab.torproject.org/tpo/web/community/-/issues/268)
Examples:
* [Tor Project | Helping survivors of domestic violence](https://community.torproject.org/training/resources/helping-survivors/)
* [content/training/resources/helping-survivors/contents.lr · community](https://gitlab.torproject.org/tpo/web/community/-/blob/main/content/training/resources/helping-survivors/contents.lr)
# Skills
Some knowledge in the following technologies may be needed in order to participate:
* Git/GitLab.
* Markdown.
* Writing documentation.
* Basic scripting (Python, shell).
# LinksHackweek 2023Silvio RhattoSilvio Rhatto2023-11-09https://gitlab.torproject.org/tpo/community/hackweek/-/issues/14Onion TeX Slim enhancements2023-11-30T16:16:39ZSilvio RhattoOnion TeX Slim enhancements# About the project
* Contact: @rhatto
* Chat: #tor-dev on `irc.oftc.net`
* Video room: to be defined.
# Participants
- @rhatto
# Summary
This proposal is about making some enhancements to [Onion TeX Slim][].
[Onion TeX Slim]: http...# About the project
* Contact: @rhatto
* Chat: #tor-dev on `irc.oftc.net`
* Video room: to be defined.
# Participants
- @rhatto
# Summary
This proposal is about making some enhancements to [Onion TeX Slim][].
[Onion TeX Slim]: https://gitlab.torproject.org/rhatto/onion-tex-slim
## Project A - Improving
* [~] Dockerfile for local builds. Moved to tpo/community/onion-tex-slim#5.
* [~] Test and improve the LaTeX templates. Moved to tpo/community/onion-tex-slim#6.
* [~] Add more functionality (graphics etc). Moved to tpo/community/onion-tex-slim#7.
* [~] Localization support, at least for the Markdown/Pandoc version. Moved to tpo/community/onion-tex-slim#2.
* [~] Make easier to add [Onion TeX Slim][] support in a `slides/` or `docs/slides` folder. Moved to tpo/community/onion-tex-slim#8.
## Project B - Trying
* [x] Use this project to build some presentations:
* [x] In the [Tor Community Training repository](https://gitlab.torproject.org/tpo/community/training/).
# Skills
Some knowledge in the following technologies may be needed in order to participate:
* Git/GitLab.
* Markdown.
* LaTeX.
* Basic scripting (Python, shell).
# LinksHackweek 2023Silvio RhattoSilvio Rhatto2023-11-09