Skip to content

CDM 2019 03

edalex-ian edited this page Mar 1, 2019 · 9 revisions

openEQUELLA Community Dev Meeting March 2019

2019-02-28 (US) / 2019-03-01 (AU)

Attendees

Chris B, Aaron H, Cath F, Ian S, Jolse M, Sam F, Joe S, Penghai Z

Working Agenda

Specific Topics

  • Moving away from Purescript (IS)
  • JS testing discussion - follow up from last month. (CM - added by IS)
  • Code style decision - follow on from last month (and hopefully mailing list discussions). (IS)
  • Admin console agreed direction update. (IS / CB)
  • Update on static analysis tooling and checks. (IS)
  • Public roadmap (IS)
  • Code reformat and implementation of pre-commit hooks. (IS / JM)
  • CDM Facilitator/Scribe role (CB)
  • Keeping the list of project committers current (CB)

General Topics

  • Review Action Items
  • Discuss code enhancements since last CDM
  • Review tech choices, code structures, direction
  • Any tech debt concerns
  • Open PRs to discuss
  • Q&A

Minutes

Review of Previous Action Items

Action Items Follow Up

  • Autotest merge - waiting on Ian S
  • README.md updated to detail new (Git Flow) branch structure
  • Admin console packaging document underway, discussion to follow
    • Chris discussing with Unicon clients
    • Ian to also check on the broader issue of the Java Applets for Edalex clients
  • Code Climate was removed
  • Joe commenced setting up CheckStyle
  • Organisation Name: Chris has discussed with Apereo, and advice was that ideally any references of EQUELLA should be replaced with openEQUELLA
  • Code formatting tools have been incorporated into the repository and get used automatically as part of the pre-commit hooks
    • Travis also does a code formatting check
  • Scalafmt is being used in the above for the Scala Code formatting

Specific Topics

  • Moving away from Purescript
    • No more will be added
    • Some items might get converted - such as the layout/template (seeing it’s a main component)
    • It is possible to convert other purescript items, but currently insufficient resources to do so.
    • Discussion of if Purescript will stay stable into the future: Feel it should remain stable in current state.
  • Public roadmap
    • Edalex is looking at a public one for their side of things - Cath to report back
    • Stick with simple GitHub Milestones for now
  • CDM Facilitator/Scribe role
    • Be good to rotate through
    • Responsibilities
      • Send out community invite (google groups)
      • Chairing the meeting
      • Capturing notes, possible a second person to take the notes (so focus is not split)
        • Whoever was facilitator last time, can be scribe the next
      • Update minutes
      • Confirming next meeting
  • Currency of project committers
    • Currently a number of people who aren’t active
    • Don't need to keep people with full write if they’re not active
    • If the community increases look at more stringent controls - possibly move to a forking model
    • Ian and Chris to determine current committers from respective organisations, and then prune the list.
    • Confirm access level for committers.
  • JS Bundling
    • Looking into the use of Parcel.js - designed for speed, and quick development processes
    • Looking into because we needed to require a CSS file and browserfy was struggling with it - compile times going up to ~2 minutes each change
    • This was also involved with Parcel, so now moved to needing to bundle into a HTML file, but still with a good result
    • Development experience is rather pleasant, and also works well with Typescript and Purescript
    • Now you run one command, and you can then edit your code live and see it over in the browser/app as you go
    • Currently still being finalised, working on Linux but just sorting out bumps on Windows
    • Also supports async bundle loading. Rather than a bundle of ‘all the things’, can now with common.js load individuals modules as needed. Not transparent, but at least we can control and start using as we need. And this bit is not Parcel specific, it's a standard that we can use in other ways. This will help address the issue where we have >2MB bundle minified.
    • Was webpack considered?
      • Not so much, as Parcel was looked at first and was “so good” that we didn’t need to go any further.
  • Draft.js
    • Coming in for the Rich Text Editor for the New UI in place of TinyMCE
    • TinyMCE unfortunately is now rather commercial, so won't sit so well with an OSS offering
    • There may be some bumps ahead to support data/content that has been authored with TinyMCE
    • Jolse also mentioned perhaps we need to look at further options
  • Lot of work on Blackboard (Bb) Building Block (B2) / Web Service fix
    • With assistance from Black Board
    • There are some issues still to be resolved, but mostly now working to a level that’s usable for existing clients
    • Moving forward, just for Building Block side of things - working unless Bb change the APIs. And these features are planned to be deprecated by Bb in the coming year. So Chris looking to have LTI/REST functionality working for 2019.1.
  • License Header and NOTICE File
    • Apereo happy with this
    • Looks like we can move forward with this, correct NOTICE file later if needed
    • Close PR #694
    • Finalise PR #699
  • Edalex, Unicon and someone from the Community will be at Apereo North American conference providing some presentations and flying the openEQUELLA flag

NEXT MEETING: 2019-04-04 (US) / 2019-04-05 (AU)

Action Items

Action Item Person
Merge equella-autotests into Equella Ian S
Discuss next steps for providing an Admin Console package Chris B & Ian S
Create GitHub Issue for conversion of Layout from Purescript to Typescript Ian S
Prepare discussion on JS testing for next CDM Christian M
Add CheckStyle to build process Joe S
Tidy up org/repo committers for Unicon Chris B
Tidy up org/repo committers for Edalex Ian S
Ensure the LTI/REST is part of the 2019.1 milestone Chris B
Finalise PRs around Copyright notice - Close #694 and finalise #699 Chris B