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

checkdocs should check if linked issues are still open #4171

Open
AlekSi opened this issue Mar 12, 2024 · 3 comments · May be fixed by #4258
Open

checkdocs should check if linked issues are still open #4171

AlekSi opened this issue Mar 12, 2024 · 3 comments · May be fixed by #4258
Assignees
Labels
code/chore Code maintenance improvements community Issues and PRs assigned to community members good first issue Good issues for new external contributors

Comments

@AlekSi
Copy link
Member

AlekSi commented Mar 12, 2024

What should be done?

https://github.com/FerretDB/FerretDB/blob/main/website/docs/reference/supported-commands.md?plain=1

We have a list of supported and unsupported commands and parameters in the file above. We should check if the linked issues are still open.

There is a code for checking if issue is open or closed in the checkcomments tool. We should refactor a shared part into a separate package and use it from both tools.

Where?

Definition of Done

  • tool updated;
  • unit tests added/updated;
  • spot refactorings done.

Updating documentation itself is not in the scope.

@AlekSi AlekSi added good first issue Good issues for new external contributors code/chore Code maintenance improvements labels Mar 12, 2024
@kropidlowsky
Copy link
Contributor

Hi @AlekSi,

Can I work on this issue?

@AlekSi AlekSi added the community Issues and PRs assigned to community members label Mar 14, 2024
@AlekSi
Copy link
Member Author

AlekSi commented Apr 16, 2024

@kropidlowsky any news? Anything we could help you with?

@kropidlowsky
Copy link
Contributor

kropidlowsky commented Apr 16, 2024

@AlekSi sorry, I was busy recently.
I will push changes in couple of days (probably Friday). Hope it works.

@kropidlowsky kropidlowsky linked a pull request Apr 24, 2024 that will close this issue
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code/chore Code maintenance improvements community Issues and PRs assigned to community members good first issue Good issues for new external contributors
Projects
Status: Open
Development

Successfully merging a pull request may close this issue.

2 participants