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: fix README and create documentation entry for dvclive #45

Closed
jorgeorpinel opened this issue Feb 17, 2021 · 5 comments · Fixed by #99
Closed

docs: fix README and create documentation entry for dvclive #45

jorgeorpinel opened this issue Feb 17, 2021 · 5 comments · Fixed by #99
Assignees
@pared
Labels
A: docs Area: user documentation
Projects
DVC 9 - 23 Feb 2021 DVC 23 Feb - 9 March 2021 DVC 9 - 23 March 2021

Comments

@jorgeorpinel
Copy link

jorgeorpinel commented Feb 17, 2021 •
edited
Loading

Part of iterative/dvc.org/issues/2026

UPDATE: Jump to #45 (comment)

Any chance you could make a quick draft for the needed API refs in https://dvc.org/doc/api-reference and maybe expand the README in this repo if needed to cover all the features @pared ? No need for details at first, just trying to cover everything even if it's just a brief mention of what you can do/how. Thanks
@jorgeorpinel jorgeorpinel changed the title docs docs (readme and api refs) Feb 17, 2021
@pared
Copy link
Contributor

pared commented Feb 17, 2021

@jorgeorpinel after iterative/dvc#5466 and #44 api method will be removed, though I agree Readme could use some polishing.

@pared pared added this to To do in DVC 9 - 23 Feb 2021 via automation Feb 17, 2021
@pared pared added the A: docs Area: user documentation label Feb 17, 2021
@pared
Copy link
Contributor

pared commented Feb 17, 2021 •
edited
Loading

TODO:

  • Fix README
  • Fix Wiki

@pared pared self-assigned this Feb 17, 2021
@jorgeorpinel jorgeorpinel changed the title docs (readme and api refs) docs: README Feb 17, 2021
@pared pared moved this from To do to In progress in DVC 9 - 23 Feb 2021 Feb 23, 2021
@efiop efiop added this to To do in DVC 23 Feb - 9 March 2021 via automation Feb 23, 2021
@efiop efiop moved this from In progress to Done in DVC 9 - 23 Feb 2021 Feb 23, 2021
@efiop efiop moved this from To do to Review in progress in DVC 23 Feb - 9 March 2021 Feb 23, 2021
@efiop efiop moved this from Review in progress to In progress in DVC 23 Feb - 9 March 2021 Feb 23, 2021
@pared pared changed the title docs: README docs: fix README and create documentation entry for dvclive Mar 2, 2021
@pared
Copy link
Contributor

pared commented Mar 2, 2021

Related to iterative/dvc.org#2227

@pared pared moved this from In progress to Review in progress in DVC 23 Feb - 9 March 2021 Mar 9, 2021
@efiop efiop added this to To do in DVC 9 - 23 March 2021 via automation Mar 9, 2021
@efiop efiop moved this from Review in progress to Done in DVC 23 Feb - 9 March 2021 Mar 9, 2021
@efiop efiop moved this from To do to Done in DVC 9 - 23 March 2021 Mar 16, 2021
@jorgeorpinel jorgeorpinel mentioned this issue May 8, 2021
Closed
8 tasks
@daavoo
Copy link
Contributor

daavoo commented Jun 10, 2021

What is the state of this issue after #71 ? Is this blocked by iterative/dvc.org#2443 ?

@pared
Copy link
Contributor

pared commented Jun 10, 2021

I think that #71 covers pretty much all relevant changes required for this to be closed, but we could leave this open and polish it according to iterative/dvc.org#2443. So far README is lacking:

  • installation methods
  • links to related technologies
  • link to Contributing (though call for collaboration is probably enough for now)
  • licen[c/s]e & citation

@jorgeorpinel jorgeorpinel mentioned this issue Jun 12, 2021
Closed
5 tasks
@daavoo daavoo mentioned this issue Jun 21, 2021
Merged
5 tasks
@pared pared closed this as completed in #99 Jun 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pared pared

Labels
A: docs Area: user documentation
Projects
No open projects
DVC 23 Feb - 9 March 2021
  
Done
DVC 9 - 23 Feb 2021
  
Done
DVC 9 - 23 March 2021
  
Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update readme daavoo/dvclive
3 participants
@jorgeorpinel @pared @daavoo