[metrics-bugs] #21379 [Metrics/metrics-lib]: Metrics-lib web-site

[Tor Bug Tracker & Wiki]

#21379: Metrics-lib web-site
---------------------------------+------------------------------
 Reporter:  iwakeh               |          Owner:  metrics-team
     Type:  enhancement          |         Status:  new
 Priority:  Medium               |      Milestone:
Component:  Metrics/metrics-lib  |        Version:
 Severity:  Normal               |     Resolution:
 Keywords:                       |  Actual Points:
Parent ID:                       |         Points:
 Reviewer:                       |        Sponsor:
---------------------------------+------------------------------

Comment (by karsten):

 RaBe, thanks for starting this by providing another great prototype!  I
 can't think of any major design changes at this point.  For example, I
 second iwakeh's suggestion to add a button for the JavaDocs rather than
 including something on this page.

 But I also think that we should first have a discussion of what content we
 want to put on this page.  For example, it's great that you used
 `README.md` and `CONTRIB.md` as input for this prototype.  But we should
 probably remove most of the contents for contributors and focus on what a
 new developer would want to know without necessarily becoming a
 contributor yet.

 Another aspect is that we might want to include links rather than actual
 contents on this page to keep this page static.  For example, rather than
 including the change log (which I suggested above, I know), it would be
 easier to just include a link to the change log.  Otherwise we'll have to
 either update the website after a new release or automate that somehow.
 We can always make it more complex later, I'd say.

 iwakeh, what do you think about the following sections:

  - DescripTor - A Tor Descriptor API for Java (1 or 2 sentences with an
 overview what it is, including CollecTor link)
  - Download (link to dist.tpo folder, most important steps for verifying,
 link to change log)
  - Dependencies ("what you still need to get, or it just won't work";
 hint: we don't need JUnit or Hamcrest, but we need Gson and SLF4j)
  - Tutorials ("how you actually use it to get started")
  - JavaDocs (just the link, maybe with > as on CollecTor page)
  - Development (short paragraph with link to sources in gitweb.tpo, bug
 tracker bugs.tpo, and team wiki page wiki.tpo, link to reproducible builds
 doc in git when available)

 How should we work on the content?  Should we check in the current
 prototype as `index.html` and edit the content in Git, ideally with
 separate commits for additions and removals?  Or should we put it on a pad
 and edit concurrently?  Or should we first discuss sections and section
 contents on this ticket before moving elsewhere?

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/21379#comment:4>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online