iterative / dvc.org

📖 DVC website and documentation
https://dvc.org
Apache License 2.0
330 stars 387 forks source link

docs: "definitive" organization #144

Closed dmpetrov closed 1 year ago

dmpetrov commented 5 years ago

UPDATE: Jump to https://github.com/iterative/dvc.org/issues/144#issuecomment-841960760; E: https://github.com/iterative/dvc.org/issues/144#issuecomment-1206648437


We need to add an additional level to the user guide:

  1. Basic
    • DVC Files and Directories
    • DVC File Format
    • External Dependencies
    • External Outputs
    • Update a Tracked File
    • Anonymized Usage Analytics
  2. Customization
    • DVC Shell Autocomplete
    • IDE Plugins & Syntax Highlighting
    • Development Version
    • Contributing

UPDATE: See discussion about structure below, and more subtasks in https://github.com/iterative/dvc.org/issues/144#issuecomment-584441916 further below

jorgeorpinel commented 1 year ago

Hi. I believe this was closed with https://github.com/iterative/dvc.org/pull/4011 but it's been here for so long I'm hesitant to press the Close button. WDYT @dberenbaum @shcheklein @casperdcl @dmpetrov ?

See the latest, simplified structure of https://dvc.org/doc/user-guide -- it will never be perfect but we have a working framework now (at least for DVC), I think.

shcheklein commented 1 year ago

Yes, I think we are good to close it for now and iterate on specific tickets.

dberenbaum commented 1 year ago

The definitive organization is complete, never to be touched again 😄

jorgeorpinel commented 1 year ago

"never"