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.

Sign up for GitHub

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

Jump to bottom

docs: contrib guide outdated, compare vs README #1125

Closed
jorgeorpinel opened this issue Apr 8, 2020 · 3 comments · Fixed by #1138
Closed

docs: contrib guide outdated, compare vs README #1125

jorgeorpinel opened this issue Apr 8, 2020 · 3 comments · Fixed by #1138
Assignees
@shcheklein
Labels
A: docs Area: user documentation (gatsby-theme-iterative)

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Apr 8, 2020 •
edited
Loading

The README has more info now which is good but should probably be reviewed so it matches the docs contrib guide (https://dvc.org/doc/user-guide/contributing/docs) and vice versa. The latter is currently outdated, still mentioning the format-staged script, for example.

Extacted from 2. in #1108

What should the README be for? If it's mainly to document some optional scripts, lets make sure all scripts are explained (purpose, depencencies, etc) either there or in the contrib guide, currently some are missing.
@jorgeorpinel jorgeorpinel added the A: docs Area: user documentation (gatsby-theme-iterative) label Apr 8, 2020
@jorgeorpinel jorgeorpinel mentioned this issue Apr 8, 2020
Closed
@jorgeorpinel jorgeorpinel mentioned this issue Apr 8, 2020
Closed
@shcheklein
Copy link
Member

shcheklein commented Apr 9, 2020 •
edited by jorgeorpinel
Loading

I would say README can be an extended version of the contrib guide. We def don't want to repeat info everywhere.

@jorgeorpinel
Copy link
Contributor Author

So an extension to the docs contrib guid, you mean? With extra info. (more optional/internal details) but not repeating the whole guide again.

@shcheklein shcheklein self-assigned this Apr 12, 2020
@shcheklein
Copy link
Member

@jorgeorpinel I'll just do something about it this weekend and prepare a PR - easiest way in this case to explain probably :)

@shcheklein shcheklein mentioned this issue Apr 12, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@shcheklein shcheklein

Labels
A: docs Area: user documentation (gatsby-theme-iterative)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

README/contributing: update after migration to Gatsby iterative/dvc.org
2 participants
@jorgeorpinel @shcheklein