search

magma / magma

Platform for building access networks and modular network services
https://www.magmacore.org/
Other
1.68k stars 608 forks source link

Migrate MCF Artifacts to LF hosted Confluence #9066

Closed aswin-alexander closed 2 years ago

aswin-alexander commented 3 years ago

Currently, MCF artifacts are not

  1. easily discoverable
  2. aggregated
  3. easy to navigate

For example, TSC captures minutes here, and videos here which are discoverable via the calendar but not on the website

This proposal is to align MCF with other LF efforts (eg: ORAN, ONAP) by using LF hosted confluence

aswin-alexander commented 3 years ago

10/4 TSC update

Notes:

Next steps:

  1. Wait for feedback/ input from the community (comments welcome here)
  2. Evaluate the walk through by LF at the next TSC
  3. Make a decision at the next TSC based on the above 2
hcgatewood commented 2 years ago

After some discussion, here's what we're proposing

Needs

  1. User-facing documentation, which goes through a code review
  2. Contributor-facing documentation, wiki-style
  3. Collaboration hub (artifacts, meeting/training recordings, meeting minutes + action items, etc — all separated by working group)

Solution

  1. Docusaurus (docs.magmacore.org) still seems like the right move
  2. GitHub wiki seems like a solid choice — can attach contributor docs directly the the relevant repo (default to magma/magma), and is wiki-style
  3. Confluence seems like a great choice here to fill in the gaps left by the other 2

We can start with this^ approach, then if Confluence goes well, we can consider moving all GitHub wiki items to confluence, but as an optional post-step

PARitter commented 2 years ago

Question: do we want to start using GitHub Wiki when we have a tentative plan to move those items to Confluence "if it goes well"? If we presume success - assume Confluence Wiki features are good and use it for item (2). Then we still have GitHub Wiki as a fallback if Confluence is deemed not good enough.

This approach gets us to the end state more quickly, without requiring an extra step through GitHub Wiki, and still leaves the same fallback position as your proposed step.

hcgatewood commented 2 years ago

It's a good point. The rationale is it feels like there's not a lot of love for confluence within the dev bench, and devops has already begun a migration to GH wiki

The inclusion of GH wiki seems like where people are naturally gravitating, so I think it could be worthwhile to let that play out and see where it lands us.

Thoughts @PARitter?

PARitter commented 2 years ago

I can work with that.

hcgatewood commented 2 years ago

Accepted. @ildikov to coordinate migrating contributor docs to GitHub Wiki, @aswin-alexander to coordinate migrating other artifacts to Confluence

Neudrino commented 2 years ago

For reference: The Linux Foundation Magma Confluence can be found at https://wiki.magmacore.org/spacedirectory/view.action.