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

Remove or make less prominent legacy contributing guide #29596

Closed
MialLewis opened this issue Jul 16, 2024 · 3 comments · Fixed by #29603
Closed

Remove or make less prominent legacy contributing guide #29596

MialLewis opened this issue Jul 16, 2024 · 3 comments · Fixed by #29603
Labels
doc:developer Developer documentation

Comments

@MialLewis
Copy link

There is a link to an outdated contributing guide here: https://github.com/apache/superset/blob/master/docs/docs/contributing/contributing.mdx?plain=1#L22

It is likely the first link to a contributing guide a user see's when following the link specified in CONTRIBUTING.md.

This guide leads users down the likely painful path of trying to set up a developer environment without docker compose, as I have just experienced.

This link should be removed, moved to a less prominent position and/or a warning added with a link to the relevant up to date page which is available in the side bar menu.

@dosubot dosubot bot added the doc:developer Developer documentation label Jul 16, 2024
@sfirke
Copy link
Member

sfirke commented Jul 16, 2024

Thanks for pointing this out. Just to be clear, you are saying the problem is the link to https://preset.io/blog/tutorial-contributing-code-to-apache-superset/ because that blog post is obsolete - correct me if that's not right.

An easy fix would be to remove that link. I wonder if that content would have been better off as part of the official docs, where it would be easier to keep updated. I'm fine with removing that link, but will also ping @mistercrunch and @rusackas as people who have thoughts about developer docs and the Preset blog.

@rusackas
Copy link
Member

Fine by me to remove it. I opened a PR to do so.

In a perfect world, we'd have the bandwidth to go back and change all our old blog posts to keep them fresh and current, but that's more than a full time job at this point, so we're probably better off treating them as time capsules, like so many blogs do. If anything, it's probably time for a NEW blog post on the topic!

@MialLewis
Copy link
Author

Thanks both.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc:developer Developer documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants