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

Deprecate Markdowngen? #2049

Open
sneakers-the-rat opened this issue Apr 3, 2024 · 3 comments
Open

Deprecate Markdowngen? #2049

sneakers-the-rat opened this issue Apr 3, 2024 · 3 comments
Assignees
Labels
generator-doc question Further information is requested

Comments

@sneakers-the-rat
Copy link
Collaborator

I see docgen being marked as a replacement for markdowngen:

Note: this is a replacement for MarkdownGenerator

And this is mentioned in an issue from 2022: #923

But markdowngen is still used in projectgen, which is often the entrypoint for new users (or at least it was for me)

MarkdownGenerator,

Describe the solution you'd like
What still needs to be done to reach feature parity? What would it take to deprecate Markdowngen?

Asking as part of an ongoing effort to slim down old code to make contributing and use approachable :) recognizing that theres a lot of history here.

How important is this feature? Select from the options below:
• Low - it's an enhancement but not crucial for work

When will use cases depending on this become relevant? Select from the options below:
• Long-term - 6 months - 1 year

@sneakers-the-rat sneakers-the-rat added question Further information is requested generator-doc labels Apr 3, 2024
@sujaypatil96
Copy link
Member

Thanks for the issue @sneakers-the-rat! I've been procrastinating this for a while. I'm OOO rest of this week, but will take this on as an item for myself next week.

@sujaypatil96 sujaypatil96 self-assigned this Apr 3, 2024
@nlharris
Copy link
Contributor

Maybe at next week's linkml dev meeting we can discuss the proper protocol for deprecating whole generators.

@sneakers-the-rat
Copy link
Collaborator Author

@nlharris ya ya- I sketched a rough set of guidelines here: https://linkml.io/linkml/developers/deprecation.html
But it lacks specific recommendations for how much of a lead we should give on removal versions. I figure its pretty case by case - eg. For each major deprecation we would decide in the issue when it should be removed, but having some table of guidelines for different types of deprecations would be great

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
generator-doc question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants