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

Check docs coverage for dvc 2.8 #2973

Closed
29 tasks done
iesahin opened this issue Oct 27, 2021 · 4 comments
Closed
29 tasks done

Check docs coverage for dvc 2.8 #2973

iesahin opened this issue Oct 27, 2021 · 4 comments
Assignees
Labels
A: docs Area: user documentation (gatsby-theme-iterative) status: research Writing concrete steps for the issue

Comments

@iesahin
Copy link
Contributor

iesahin commented Oct 27, 2021

This is a tracking issue to check whether the following new features and bug fixes (should) have corresponding docs updates/PRs.

🚀 New Features and Enhancements

🐛 Bug Fixes

@iesahin iesahin self-assigned this Oct 27, 2021
@iesahin iesahin added status: research Writing concrete steps for the issue A: docs Area: user documentation (gatsby-theme-iterative) labels Oct 27, 2021
@iesahin
Copy link
Contributor Author

iesahin commented Oct 27, 2021

Waiting for @skshetry 's response in iterative/dvc#6692.

Created #2975 and #2974 for this.

@skshetry
Copy link
Member

skshetry commented Oct 27, 2021

@iesahin, please sanitize the changelog next time, i.e remove contributors' mentions, this sends a spam notification to the contributors. Also, are we going to do this regularly from now on?

@iesahin
Copy link
Contributor Author

iesahin commented Oct 27, 2021

Ah, sorry, @skshetry. I should have thought it.

@jorgeorpinel was doing this before, this time I decided to take over but with much unnecessary noise, it looks.

I try to do much of these work in the open. I don't know what we'll do for the next release, but we may continue to do it. These do not replace the docs PR requirements BTW, just a double check we're not missing anything.

Thank you, and sorry again.

@iesahin iesahin closed this as completed Oct 27, 2021
@jorgeorpinel
Copy link
Contributor

Thanks @iesahin I'm not 100% convinced we need issues for these although I guess it's better to formalize all the things we already do anyway (like this). Should def. not re-mention all the PR authors though, as we all agree.

It's probably enough to link to the release (i.e. https://github.com/iterative/dvc/releases/tag/2.8.0) and only add checkboxes for anything that's missing.

are we going to do this regularly from now on?

Yep, been doing it for a ling time informally, at least for new features and relevant changes. We're starting to spread the load among @iterative/docs members + @dberenbaum 😬 — the process part is WIP and we're happy to discuss better approaches with the core team.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: docs Area: user documentation (gatsby-theme-iterative) status: research Writing concrete steps for the issue
Projects
None yet
Development

No branches or pull requests

3 participants