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

📖 Add Roadmaps to bring visibility and allow better collaboration #3835

Merged
merged 1 commit into from
Apr 23, 2024

Conversation

camilamacedo86
Copy link
Member

@camilamacedo86 camilamacedo86 commented Mar 30, 2024

Overview

This PR introduces the addition of detailed roadmaps to our project. These documents outline our strategic objectives, planned initiatives, and focus areas for the upcoming periods. The primary goal is to enhance visibility into the project's direction and foster a more collaborative environment for both current contributors and newcomers.

What's Included

  • Project Roadmap 2024: Outlines our major goals and initiatives for 2024, focusing on improving maintainability, user experience, and integrating new functionalities that meet our community's needs.

Goals

  • Enhance Visibility: By clearly articulating our plans and priorities, we aim to provide all stakeholders with a transparent view of where the project is headed.
  • Encourage Collaboration: The roadmaps are designed to invite contributions and feedback from the community, ensuring that the project benefits from a diverse range of perspectives and expertise.
  • Streamline Contribution Process: New and existing contributors can easily identify areas where their efforts can have the most impact, aligning with the project's strategic goals.

Thank you for your support and collaboration!

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Mar 30, 2024
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 30, 2024
@camilamacedo86 camilamacedo86 force-pushed the doc-roadmap branch 2 times, most recently from 6d23663 to 5b7b73c Compare March 30, 2024 12:55
@camilamacedo86
Copy link
Member Author

/hold

Please folks feel free to LGTM and approve this one
We are holding to let more people review.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 30, 2024
@k8s-ci-robot
Copy link
Contributor

@uos-ljtian: changing LGTM is restricted to collaborators

In response to this:

/lgtm

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Copy link
Contributor

@Kavinjsir Kavinjsir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super excited about the roadmap and very much looking forward to engaging in contributions based on the expected trajectory!

Just left a nit and raised a proposal for some topics previously discussed in the community.

I also have some questions:

  1. How do we plan to maintain the roadmap each year? I think it might be necessary for us to evaluate it periodically, which could help us check if we are heading in the right direction and if new topics of interest are emerging from the community.
  2. I like the structure of each topic, which includes status, objective, motivation, and context. Would it be possible to create a template for this so that every topic can be aligned in the same format?

roadmap/roadmap_2024.md Outdated Show resolved Hide resolved
roadmap/roadmap_2024.md Outdated Show resolved Hide resolved
@camilamacedo86 camilamacedo86 force-pushed the doc-roadmap branch 3 times, most recently from 51e36a5 to 51d1c2a Compare April 1, 2024 08:20
Copy link
Member Author

@camilamacedo86 camilamacedo86 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Kavinjsir

I tried to address all your comments. Following the answer of your questions inline

How do we plan to maintain the roadmap each year? I think it might be necessary for us to evaluate it periodically, which could help us check if we are heading in the right direction and if new topics of interest are emerging from the community.

If we see that we need to add an macro goal we can push a PR within and to do the discussion. However, we need to keep in mind that we have not a lot of effort available
So, I would say for we try to keep the list short with 5 items in the max. Just what is more
important/crucial in the year.

However, yes. That is live doc and we can and should keep it update when possible.
For example, if we delivery something we should update to complete so that we know
that goal was accomplished in the year.

Nothing is write in a stone :-)
We can either remove/change and etc any goal if we see that is required.
The idea is to bring more visibility about what we need / what we want to acomplish
the direction of the project and see if we can win more help as well since it makes clear what is most important at the moment.

I like the structure of each topic, which includes status, objective, motivation, and context. Would it be possible to create a template for this so that every topic can be aligned in the same format?

It was added. Good Point 🥇

@camilamacedo86 camilamacedo86 force-pushed the doc-roadmap branch 2 times, most recently from a0d33db to 156a682 Compare April 1, 2024 08:50
@Kavinjsir
Copy link
Contributor

Hi @Kavinjsir

I tried to address all your comments. Following the answer of your questions inline

How do we plan to maintain the roadmap each year? I think it might be necessary for us to evaluate it periodically, which could help us check if we are heading in the right direction and if new topics of interest are emerging from the community.

If we see that we need to add an macro goal we can push a PR within and to do the discussion. However, we need to keep in mind that we have not a lot of effort available So, I would say for we try to keep the list short with 5 items in the max. Just what is more important/crucial in the year.

However, yes. That is live doc and we can and should keep it update when possible. For example, if we delivery something we should update to complete so that we know that goal was accomplished in the year.

Nothing is write in a stone :-) We can either remove/change and etc any goal if we see that is required. The idea is to bring more visibility about what we need / what we want to acomplish the direction of the project and see if we can win more help as well since it makes clear what is most important at the moment.

I like the structure of each topic, which includes status, objective, motivation, and context. Would it be possible to create a template for this so that every topic can be aligned in the same format?

It was added. Good Point 🥇

Hey @camilamacedo86, I appreciate your comment!
It totally makes sense to keep it a live document with the flexibility to incorporate community feedback.

The way I see the proposed roadmap is as a guide to ensure we're moving Kubebuilder (kb) in the right direction.
Personally, I'd like to suggest evaluating the docs periodically, perhaps quarterly through meetings.

Additionally, I wonder if it's possible or necessary for us to align our goals with KubeCon events.
This could help us disseminate updates about Kubebuilder and gather more feedback from a wider audience.

@camilamacedo86
Copy link
Member Author

Hi @Kavinjsir

Additionally, I wonder if it's possible or necessary for us to align our goals with KubeCon events.

About this one, if we do any other talk about Kubebuilder in the contribution track for example I think we can share it for sure and let me people comment if they wish to do so.

@camilamacedo86
Copy link
Member Author

/override pull-kubebuilder-e2e-k8s-1-29-2

Reason:https://kubernetes.slack.com/archives/CCK68P2Q2/p1712378775102839

@k8s-ci-robot
Copy link
Contributor

@camilamacedo86: Overrode contexts on behalf of camilamacedo86: pull-kubebuilder-e2e-k8s-1-29-2

In response to this:

/override pull-kubebuilder-e2e-k8s-1-29-2

Reason:https://kubernetes.slack.com/archives/CCK68P2Q2/p1712378775102839

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@camilamacedo86
Copy link
Member Author

Hi @varshaprasad96

I think this one is good to fly.
The idea is change it and keep it updated as well

So, we can always address follow ups.
WDYT?
Could we get this one merged?

@camilamacedo86 camilamacedo86 removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 16, 2024
@camilamacedo86
Copy link
Member Author

/hold cancel

We shared it in the malling list + channel
We gave a good time for objections and reviews
We can change things up always
So, I am removing the hold to allow it get merged within the next lgtm

Copy link
Member

@varshaprasad96 varshaprasad96 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @camilamacedo86! This looks good! Just one nit on adding about k8s bumps to keep KB in sync with recent changes in the community, but that is indirectly implied from controller-runtime's bump.

/lgtm
/approve

and allow easily integrations with common applications used by administrators.

---
### Updating Scaffolding to Align with the Latest changes of controller-runtime
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could also add that this involves updating dependencies based on k8s bumps. It would be nice to have community's help on this too.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no objetions about we add a follow up like "Keep the project updated with the edge" so that we clarify that is a goal as well for all deps.

However, I think we have this goal already by default right. It might be implicit in keep the project maintained.

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 22, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, Kavinjsir, varshaprasad96

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:
  • OWNERS [camilamacedo86,varshaprasad96]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit 1ccc46b into kubernetes-sigs:master Apr 23, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants