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

Establishing a Process to Prevent Duplication in LWKD Articles #250

Open
fykaa opened this issue Oct 18, 2023 · 6 comments
Open

Establishing a Process to Prevent Duplication in LWKD Articles #250

fykaa opened this issue Oct 18, 2023 · 6 comments
Labels
kind/feature Categorizes issue or PR as related to a new feature.

Comments

@fykaa
Copy link
Member

fykaa commented Oct 18, 2023

I've noticed that when working on KEPs, merge requests, and featured pull requests for LWKD, we often run into the issue of duplicating efforts because it's challenging to keep track of what's already been discussed in our LWKD articles. To streamline our workflow and improve efficiency, I propose we establish a process to recognize and track these discussions.

Objective:
The main goal is to prevent the duplication of topics in forthcoming articles by keeping a record of what has already been covered in LWKD.

Suggested Approach:

  1. Create a central document or database where we can log and categorize KEPs, merge requests, or featured pull requests that have been discussed in LWKD.

  2. Before starting work on a particular topic, contributors should check this document to ensure it hasn't been covered recently.

  3. If a topic has already been discussed, we can provide links to the relevant LWKD articles for reference.

Benefits:

  • Saves time and effort by avoiding redundant work.
  • Ensures that LWKD articles remain diverse and cover a wide range of topics.

Discussion:
Please share your thoughts and suggestions on how to implement this process effectively. If you have any ideas or tools in mind that can help us achieve this, feel free to contribute to the discussion.

Let's work together to improve our workflow and make LWKD even more efficient. Your input is highly appreciated!

@fykaa fykaa added the kind/feature Categorizes issue or PR as related to a new feature. label Oct 18, 2023
@professorabhay
Copy link

Hey @fykaa ! Is this open for all ?

@jberkus
Copy link
Contributor

jberkus commented Dec 1, 2023

This only really applies to KEPs. PRs are current for the week, so there's no possibility of duplication. We avoid duplication of developer news just by checking last week's issue, because again, they're very time-bound.

So, +1 to having a log somewhere of which KEPs have been featured.

@jberkus
Copy link
Contributor

jberkus commented Dec 1, 2023

Hey, @professorabhay ! This issue is a "process issue" for existing LWKD contributors. It's not a good place to get started.

@sreeram-venkitesh
Copy link
Member

sreeram-venkitesh commented Dec 3, 2023

What I generally do for avoiding repetition while writing KEP of the Week is search for the KEP number globally in the repo and check if it has been featured in KEP of the Week in any previous issue. I have a general idea of KEPs I've written before, but I make sure to do this before I start writing so that I can be sure no other contributor who has written KEP of the Week has already written about the KEP I'm choosing for the week.

This works for me now since the list is small. Documenting all of the features KEPs would really help in the longer run and make things easier.

@mfahlandt
Copy link
Contributor

An idea would be to basically go through the articles with a script and try to regex the KEP and featured PR's and maintain a list.
I played around a bit and in general it is working, but it would be easier if of course the link definition would be fixed like described in #267. If there is no opposition, I would give it a try.

@fykaa
Copy link
Member Author

fykaa commented Mar 1, 2024

So what I recently started doing is simply search the KEP no./ PR no. / others in the LWKD repo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

No branches or pull requests

5 participants