Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • Trac Trac
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Issues 246
    • Issues 246
    • List
    • Boards
    • Service Desk
    • Milestones
  • Monitor
    • Monitor
    • Metrics
    • Incidents
  • Analytics
    • Analytics
    • Value stream
  • Wiki
    • Wiki
  • Activity
  • Create a new issue
  • Issue Boards
Collapse sidebar
  • Legacy
  • TracTrac
  • Issues
  • #32619

Closed (moved)
(moved)
Open
Created Nov 26, 2019 by eighthave@eighthave

fix syntax errors in torspec documents

https://github.com/torproject/torspec/pull/95 fixes a handful of errors in the syntax of things like the title line and the section names. That makes these files much more machine readable. All of the changes here are trivial.

With these changes, then a script can convert these files to a nice collection of HTML pages in a CI job that takes less than a minute to run:

  • https://gitlab.com/eighthave/torspec/-/jobs/362125193
  • https://eighthave.gitlab.io/torspec/

This provides nice features like links to sections based on the section name:

  • https://eighthave.gitlab.io/torspec/control-spec.html#hsfetch
  • https://eighthave.gitlab.io/torspec/control-spec.html#circuit-status-changed
  • https://eighthave.gitlab.io/torspec/tor-spec.html#tls-security-considerations

Using GitLab CI, this could easily rsync the result to any webserver.

To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information
Assignee
Assign to
Time tracking