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

Update documentation for how to use the new update script #20820

Closed
foolip opened this issue Sep 26, 2023 · 1 comment
Closed

Update documentation for how to use the new update script #20820

foolip opened this issue Sep 26, 2023 · 1 comment
Labels
enhancement Nice to have features.

Comments

@foolip
Copy link
Collaborator

foolip commented Sep 26, 2023

What would you like to see added to BCD?

#19971 moved the update-bcd script from mdn-bcd-collector into BCD, but we have not updated documentation for how to use this new script. https://github.com/mdn/browser-compat-data/blob/main/docs/contributing.md#optional-generating-data-using-the-mdn-bcd-collector-project links to https://mdn-bcd-collector.gooborg.com/docs/update-bcd.md.

How impactful do you think this enhancement will be?

The main thing is that we should avoid any divergence between the original update-bcd and the one that was moved into BCD. Although a bit painful at first, I think we should do this by ensuring that the script in BCD itself is fully up to the task, and refer to it in docs.

Do you have anything more you want to share?

cc @Elchi3 @queengooborg

@Elchi3
Copy link
Member

Elchi3 commented Oct 3, 2023

Closing this as we want to keep the update scripts with the collector. I will take a look at the docs if they are good.

@Elchi3 Elchi3 closed this as completed Oct 3, 2023
@Elchi3 Elchi3 closed this as not planned Won't fix, can't repro, duplicate, stale Oct 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Nice to have features.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants