Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
Trac
Trac
  • Project overview
    • Project overview
    • Details
    • Activity
  • Issues 246
    • Issues 246
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Operations
    • Operations
    • Metrics
    • Incidents
  • Analytics
    • Analytics
    • Value Stream
  • Wiki
    • Wiki
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Create a new issue
  • Issue Boards

GitLab is used only for code review, issue tracking and project management. Canonical locations for source code are still https://gitweb.torproject.org/ https://git.torproject.org/ and git-rw.torproject.org.

  • Legacy
  • TracTrac
  • Issues
  • #12507

Closed (moved)
Open
Opened Jul 01, 2014 by Isis Lovecruft@isis

Automate BridgeDB documentation builds

The developer documentation for BridgeDB needs a place to live. Currently, Sphinx builds can be manually triggered to produce HTML documentation (as well as other types). I have been manually scp'ing it to https://para.noid.cat/bridgedb, mostly because I had no idea where to put it, but wanted to put it somewhere.

So...

  1. We should probably ask TPO's sysadmins to create something like https://docs.torproject.org/bridgedb, or wherever people want to use for keeping common developer documentation.

  2. I think there was some sort of funding for this. I've just been doing this because I needed to understand how BridgeDB works and it was entirely undocumented when I started working on it. If someone knows who that funder is, please comment/tag this ticket as appropriate.

  3. Documentation builds should probably be triggered automatically when a new signed tag is pushed to git.torproject.org/bridgedb.git.

To upload designs, you'll need to enable LFS and have admin enable hashed storage. More information
Assignee
Assign to
None
Milestone
None
Assign milestone
Time tracking
None
Due date
None
Reference: legacy/trac#12507