Opened 3 years ago

Closed 3 years ago

#21730 closed enhancement (fixed)

Include metrics-lib's JavaDocs on the Metrics website

Reported by: karsten Owned by: iwakeh
Priority: Medium Milestone:
Component: Metrics/Website Version:
Severity: Normal Keywords:
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

We should include metrics-lib's JavaDocs on the Metrics website, possibly at https://metrics.torproject.org/metrics-lib/*. We'll likely want to automate this using Ant and possibly a Git submodule. For that we could either build metrics-lib as part of metrics-web, or we could just generate the docs for metrics-lib's sources in metrics-web's build file. Once we have this Git-and-Ant magic in place we should update metrics-lib.jsp and link to the JavaDocs, once in the jumbotron and once more in the "Next steps" section.

Child Tickets

Change History (5)

comment:1 Changed 3 years ago by iwakeh

Owner: changed from metrics-team to iwakeh
Status: newassigned

comment:2 Changed 3 years ago by iwakeh

Status: assignedneeds_review

A first suggestion:

Please find three commits here that implement the metrics-lib javadoc inclusion and prepare onionoo and collector web page integration (#21551).

(I didn't run the war in tomcat. There was a white space warning for the servlets in some of the latest commits on master.)

comment:3 Changed 3 years ago by karsten

I read the three commits, and they look good. But I failed getting submodules initialized. Can you maybe post the exact commands for cloning a new metrics-web repository and building the .war file? I may be missing an initialization command, but I can't figure out which. Thanks!

comment:4 Changed 3 years ago by iwakeh

Thanks, for checking!
I forgot to commit the bootstrap script and also found a bug.
All is ammmended to the above branch.

Step by step:
If the checkout wasn't recursive, run

website/src/main/resources/bootstrap-development.sh

Then add the lib folder under shared (this is nothing new).
cd into website and run ant war.
This should result in all javadocs being build, but only
metrics-lib's javadoc is included in the war.

comment:5 Changed 3 years ago by karsten

Resolution: fixed
Status: needs_reviewclosed

Great, that works! Merged to master. Thanks! Closing.

Note: See TracTickets for help on using tickets.