Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate MCF Artifacts to LF hosted Confluence #9066

Closed
aswin-alexander opened this issue Sep 11, 2021 · 7 comments
Closed

Migrate MCF Artifacts to LF hosted Confluence #9066

aswin-alexander opened this issue Sep 11, 2021 · 7 comments
Labels
status: accepted type: proposal Proposals and design documents

Comments

@aswin-alexander
Copy link

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 aswin-alexander added the type: proposal Proposals and design documents label Sep 11, 2021
@aswin-alexander
Copy link
Author

10/4 TSC update

Notes:

  • Jessica W (LF) to provide a walk through next week of ONAP
  • Kendall (LF) confirmed the MCF package covers this hosting service
  • The outreach committee already uses it

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
Copy link
Contributor

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
Copy link
Member

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
Copy link
Contributor

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
Copy link
Member

I can work with that.

@hcgatewood hcgatewood added status: accepted and removed status: needs presentation Needs to be presented at the TSC meeting labels Dec 13, 2021
@hcgatewood
Copy link
Contributor

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

@Neudrino
Copy link
Contributor

Neudrino commented Mar 7, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: accepted type: proposal Proposals and design documents
Projects
None yet
Development

No branches or pull requests

4 participants