Skip to content
This repository has been archived by the owner on May 29, 2018. It is now read-only.

Meeting 03 24 15

Jump to bottom
Samer Masterson edited this page Mar 25, 2015 · 4 revisions

actionable items

Jelmer

  • sign up for the mailing lists
  • get srclib feedback from Ph.D. friend.
  • srclib welcome /introductory text
  • read srclib-go documentation and code
  • start focusing on the API page.
  • get back to Samer about Slack channels/communication

Samer

  • look into using Redmine for task lists/gantt charts
  • schedule weekly or monthly hangout with srclib team
  • work on src q
  • add bugs to wiki

srclib dev organization

How can the (progress, details of) srclib work that we do be as transparent as possible for outsiers?

Let's use slack more. How about 1 channel per toolchain, of per concept (srclib.org webpage)

  • find the smallest set of channels that we can work with
  • channels: website, docs, toolchains (1 channel, split them later when volumes of communication grow)

For people that are not on Slack: how can you make sure people are able to see what's happening?

  • one idea is a project/ticket management system, very lightweight, so it isn't a drag to make a new ticket or to keep track of them. Redmine is one ticket system that has a lot of extensions available.
  • another idea can be to assign contributors to components as representatives that ought to keep their project page / roadmap up to date.

frontpage

  • short description of what srclib is?
  • how others have used it (in the future)

scanner output

reference data type: documented with a Go type https://srclib.org/toolchains/scanner-output/

  • it's JSON, focus more on that. visitors might not need all information here to use it.

srclib documentation in general

what documentation should be here first? what does someone watching srclib.org need to know, and how can you pull that out of the makedoc script?

srclib-store

the srclib store allows us to make fast queries without an external database. There's an issue with deep technical documentation we want to adress:

The way Samer sees deep technical documentation:

  • this should be in the code
  • generate it from what's written in the code

How best to do this? Godoc seems limited but it can be a building block for a new tool.

src q

Samer is working on srclib query or "src q". The power of srclib but easy to access. It has fast cli code search. Samer wants it to be very responsive, show documentation and example usage.

Clone this wiki locally