Hi Evan,
I support this monorepo structure - as you stated, there are
several benefits of consolidating the Apache Flagon projects. Just a few
questions/suggestions:
- Do you have a timeline in mind for:
- When should this process begin? *In terms of where UserALE and Distill
currently are.*
- The scope and sequence of the changes? Roadmap for the migration?
- For documentation, do we intend to use ReadTheDocs and Sphinx? Any
others that you might know of?
- I think we should set up a robust CI/CD pipeline to handle the
monorepo to ensure that all projects are integrated seamlessly and that
automated tests are in place for the monorepo.
Best,
*Amir M. Ghaemi*
On Thu, Jan 25, 2024 at 3:01 PM Evan Jones <evan.a.jon...@gmail.com> wrote:
> There are likely a few more steps:
>
> 1. Send a do not merge email for all repos
> 2. Add userale/distill code, git tree, and github actions to the flagon
> repo
> 3. *Consolidate documents into a single repo*
> 4. *Migrate to a build tool for monorepos like Bazel* (example:
> https://github.com/thundergolfer/example-bazel-monorepo/tree/master/cli;
> Beam uses gradle)
> 5. Mark userale/distill repos as archived and update read me with a link
> 6. Send a merge freely email
> 7. Update flagon readme and flagon site links
>
> The bolded things could happen after the structural changes depending on
> our priorities. If we implement those changes as part of the migration it
> would simplify contribution conventions post migration but slow things down
> in the short-term. If we implement them after, we'll open back up to merges
> faster but the repo will be in a "dirty" state for longer as we transition
> to monorepo best practices.
>
> > I don't think there's anything besides the flagon site that points to any
> github repo, but I'm not sure.
>
> We definitely want to check our p's and q's though, especially on the
> Apache side. Are the Distill, UserALE and Flagon repos treated as separate
> projects / releases in the eyes of Apache or are their releases all bundled
> into Flagon releases?
>
> Best
>
> Evan Jones
> Website: www.ea-jones.com
>
>
> On Thu, Jan 25, 2024 at 10:40 AM Jason Young <j...@apache.org> wrote:
>
> > I'm all for a monorepo. Especially because it's hard to get visibility
> > into a single project when its spread across multiple repos in the sea of
> > the Apache GitHub org.
> >
> > Are these what the steps look like for moving to a monorepo?
> >
> > 1. Send a do not merge email for all repos
> > 2. Add userale/distill code, git tree, and github actions to the flagon
> > repo
> > 3. Mark userale/distill repos as archived and update read me with a link
> > 4. Send a merge freely email
> > 5. Update flagon readme and flagon site links
> >
> > I don't think there's anything besides the flagon site that points to any
> > github repo, but I'm not sure.
> >
> > On 2024/01/17 00:36:41 Evan Jones wrote:
> > > Hi all,
> > >
> > > I've recently had more bandwidth to contribute to Flagon. Recently, I
> > > helped with the release of Flagon-Distill v0.1.0 and am leading up the
> > > instrumentation team at ARLIS. My goal is for us to ramp up our
> > > contribution to the Flagon suite.
> > >
> > > After spending quite a bit of time thinking about Flagon, I've come to
> > > believe the best way for Flagon to deliver truly differentiated value
> to
> > > end users is to deliver on the original vision of all the sub-projects:
> > >
> > > - UserALE for instrumentation
> > > - Distill for analytics
> > > - STOUT as a UI for the analytics, metrics, and experiment
> > > - TAP (re-envisioned) as the infrastructure platform to connect all
> > > those pieces
> > >
> > > By eventually building all these pieces, Flagon could be a very strong
> > > open-source alternative to services like Google Analytics, LogRocket,
> and
> > > others. I intend to socialize the above vision more in the future. For
> > now
> > > I digress since that's not the point of this email.
> > >
> > > The point of this email is to share an RFC
> > > <
> >
> https://docs.google.com/document/d/1xxZDchgjLswbzWpVz0GcRlLqLCEygW_cTvcLhsombtk/edit?usp=sharing
> > >
> > > for *an overhaul I believe needs to happen as a precursor to achieving
> > the
> > > above vision*.
> > >
> > > *Please share feedback, comments and concerns right on the google doc*.
> > > I've also opened a GH issue <
> https://github.com/apache/flagon/issues/44>
> > if
> > > folks would like to contribute to the conversation there, though I
> prefer
> > > to keep as much commentary within the document itself to simplify
> > collation
> > > later.
> > >
> > > Many thanks!
> > >
> > > Best
> > >
> > > Evan Jones
> > >
> >
>
