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

update docs with cloud versioning info #4089

Closed
5 of 8 tasks
dberenbaum opened this issue Oct 31, 2022 · 11 comments · Fixed by #4359
Closed
5 of 8 tasks

update docs with cloud versioning info #4089

dberenbaum opened this issue Oct 31, 2022 · 11 comments · Fixed by #4359
Assignees
@pmrowla
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: cases Content of /doc/use-cases C: guide Content of /doc/user-guide C: ref Content of /doc/*-reference ✨ epic Placeholder ticket for multi-sprint direction, use story, improvement p1-important Active priorities to deal within next sprints

Comments

@dberenbaum
Copy link
Contributor

dberenbaum commented Oct 31, 2022 •
edited
Loading

Report

Docs to be updated:
@dberenbaum dberenbaum added the A: docs Area: user documentation (gatsby-theme-iterative) label Oct 31, 2022
@jorgeorpinel jorgeorpinel added the ✨ epic Placeholder ticket for multi-sprint direction, use story, improvement label Oct 31, 2022
@jorgeorpinel
Copy link
Contributor

Do we have a timeline for this feature release? Expected DVC version? Thanks

@jorgeorpinel jorgeorpinel added C: guide Content of /doc/user-guide C: ref Content of /doc/*-reference C: cases Content of /doc/use-cases labels Oct 31, 2022
@dberenbaum
Copy link
Contributor Author

We are aiming for release around the start of December. I don't have an expected DVC version. The changes aren't breaking for now since users have to configure flags to use cloud versioning, so I don't think the version number matters too much. The plan is to put something out soon and start getting feedback rather than wait for a major release.

@dberenbaum dberenbaum added the p1-important Active priorities to deal within next sprints label Nov 30, 2022
@dberenbaum dberenbaum added this to DVC Nov 30, 2022
@dberenbaum dberenbaum moved this to Backlog in DVC Nov 30, 2022
@dberenbaum dberenbaum mentioned this issue Dec 5, 2022
Merged
@dberenbaum
Copy link
Contributor Author

@pmrowla Should we add version_id to https://dvc.org/doc/user-guide/project-structure/dvc-files?

@dberenbaum
Copy link
Contributor Author

I think we can close this one after we address that (we can address adding more high-level content into use cases, get started, etc. in separate issues).

@jorgeorpinel
Copy link
Contributor

Also the config and push refs?

@dberenbaum
Copy link
Contributor Author

Also the config and push refs?

For config, the remote section just refers users to the dvc remote ref, so I don't think there's actually an updated needed.

For push, I'm not sure what needs to be added. Maybe an example?

@dberenbaum
Copy link
Contributor Author

Actually, the https://dvc.org/doc/command-reference/import-url synopsis is missing the --version-aware option, so that also needs to be done.

@jorgeorpinel jorgeorpinel mentioned this issue Jan 26, 2023
Merged
2 tasks
jorgeorpinel added a commit that referenced this issue Jan 26, 2023
@jorgeorpinel
ref: add import-url --version aware to Synopsis
06da52e 
per #4089 (comment)
@daavoo daavoo moved this from Backlog to In Progress in DVC Feb 14, 2023
shcheklein pushed a commit that referenced this issue Feb 17, 2023
@jorgeorpinel @rogermparent
@restyled-io @restyled-commits
ref: remote updates (#4062)
108b121 
* guide: draft structure of Data Mgmt and
some updates around the topic in existing docs

* guide: full text for draft intro to DM

* guide: hide cloud versioning info
per #4042 (review)

* guide: clarify Data Mgmt parts and
add prospective figure titles

* guide: add figure drafts to Data Mgmt

* guide: SCM->VC (Data Mgmt)

* guide: update 2 figs and add 1 more (Data Mgmt)

* guide: roll back unrelated changes
per #4042 (review)

* guide: mention clouds first (DM) and

and update fig. 1
per #4042 (review)

* guide: flatten DM index
per #4042 (review)

* guide: udpates to DM/ DV
moved from #4053 (review)

* guide: add DM/ Data Versioning page

per #4042 (comment)

* guide: update outdated link

* guide: revert more unrelatedly chaqnged files

per #4042 (review)

* guide: remove unused ref link

* guide: DM/ Remote Storage (not just Setup) and

and some links from cmd refs
and avoid term "data remote"
and some admons nearby...

* guide: remove a comment

* guide: draft for DM/ Remote Storage content

* ref: expand config.remote and link to/from Remotes guide

* ref: fix remote config file examples

* guide: complete Remote Config section and

and add Project config section to DM/ DV guide

* ref: rewrite remote add and modify Descs

* guide: complete list of supported storage types

* ref: rewrite remote index page from

extracted from #4053

* guide: clarify `remote modify` phrase in

in the Remote config section of DM/ Remote Storage

* Update content/docs/user-guide/data-management/data-versioning.md

* guide: update versioning config

per #4058 (review)

* guide: don't call remote storage "additional" here

(in the DM/ Remote Storage guide)
per #4058 (review)

Co-authored-by: Dave Berenbaum <[email protected]>

* guide: pull -> download (DM/ RS intro)

* guide: remove "optional" from Remote Storage nav & title

per #4058 (review)

* guide: splits and notes around Data Mgmt index page

rel. #4042 (comment)

* guide: Data Mgmt intro + note updates

* guide: draft of all contents +

+ remove comments

* guide: small impros to Data Mgmt

in prep for #4042 (review)

* guide: rewrite Data Mgmt index in before/after form

per #4042 (review)

* guide: add draft figure for Data Mgmt

* guide: simplify/refocus data mgmt index

per #4042 (review)

* work around commented header bug

* guide: drop DM/ DV page

* guide: rewrite DM intro and

- hide benefits (for now)
- remove codification comment block

* guide: use DM table instead of figure for now

* guide: rewrite Data Mgmt story

* guide: add draft figures to Data Mgmt

* guide: simplify Data Mgmt story and benefits

* guide: remove unused images (DM)

* guide: update Data Mgmt figures (v1)

* guide: rewrite text of Data Mgmt index

* guide: update Data Mgmt figures

* guide: iterate on Data Mgmt again

* guide: update Data Mgmt figs

* guide: more supporting info about Data Mgmt

* guide: update figures (much more concrete) and

and matching text updates

* guide: edits to How it works (Data Mgmt)

* guide: update Data Mgmt figures

Rel. #4042 (comment)

* guide: emphaisze dataset versions in UG fig 1

Rel. #4042 (comment)

* guide: update Data Mgmt figures (with notes),

expand img captions,
and update text accordingly.

* guide: more updates to text and figure styles,

esp. to the first half
and comment some stuff out (temporary)

* guide: update figures and text (Data Mgmt) ...

Using a tabs toggle for the 2nd fig.

* guide: Data Management text (section 1)

finalized for this version of figures

* guide: Data Management (main text)

finalized for this version of figures

* guide: Data Management (secondary text)

pending diagram and code sample(s)

* guide: add DVC data mgmt technical diagram &

dummy sample CLI blocks

* guide: update Data Mgmt text

* guide: udpate text and 2nd figure (Data Mgmt)

* guide: draft 2nd and 3rd figures

* guide: rewrite Data Mgmt/ How it works &

and Benefits/ Tradeoffs

Probably still unfinished... Missing more data versioning info? See HTML comments.

* guide: update drafts of Data Mgmt figures 2, 3

* guide: Data Mgmt improvements and

hide the benefits list for now

* guide: separate from Data Mgmt work

Rel. #4042

* Apply suggestions from code review

* Merge branch main +

* ref: bring cloud versioning copy edits of import-url

from
https://github.com/iterative/dvc.org/pull/4260/files#diff-ef95e18c4bd039757695065a23946dc27e28b4727ce07c670cdc096e34dbe3b3

* ref: clarify import-url with cloud versioning

per #4142 (review)

* ref: updates to import-url --version-aware and

update --rev

* ref: add import-url --version aware to Synopsis

per #4089 (comment)

* Restyled by prettier (#4266)

Co-authored-by: Restyled.io <[email protected]>

* ref: updates around worktree updates (cloud versioning)

* ref: link from `remote` (index) to storage types

* guide: roll back changes to dvc.yaml `rev` field spec

* Update content/docs/command-reference/update.md

* guide: link refs in .dvc file spec

* Restyled by prettier (#4319)

Co-authored-by: Restyled.io <[email protected]>

* Update content/docs/command-reference/update.md

---------

Co-authored-by: Dave Berenbaum <[email protected]>
Co-authored-by: rogermparent <[email protected]>
Co-authored-by: restyled-io[bot] <32688539+restyled-io[bot]@users.noreply.github.com>
Co-authored-by: Restyled.io <[email protected]>
@dberenbaum
Copy link
Contributor Author

  • especially for GCS since their defaults are very strict (cc @daavoo)

@daavoo Do you remember where you saw this?

@daavoo
Copy link
Contributor

daavoo commented Feb 23, 2023

@daavoo Do you remember where you saw this?

In the GCS page when you create a new bucket with versioning enabled

@shcheklein
Copy link
Member

@dberenbaum do we plan to do any other updates within this epic?

@shcheklein shcheklein changed the title Update docs with cloud versioning info update docs with cloud versioning info Mar 1, 2023
@dberenbaum
Copy link
Contributor Author

I hope to at least make some progress on the other checkboxes so we can close this one.

@dberenbaum dberenbaum mentioned this issue Mar 3, 2023
Merged
@github-project-automation github-project-automation bot moved this from In Progress to Done in DVC Mar 3, 2023
shcheklein pushed a commit that referenced this issue Mar 9, 2023
@jorgeorpinel @rogermparent
@restyled-io @restyled-commits @omesser
ref: links to Remote Storage guide, and... (#4260)
32c6439 
* guide: draft structure of Data Mgmt and
some updates around the topic in existing docs

* guide: full text for draft intro to DM

* guide: hide cloud versioning info
per #4042 (review)

* guide: clarify Data Mgmt parts and
add prospective figure titles

* guide: add figure drafts to Data Mgmt

* guide: SCM->VC (Data Mgmt)

* guide: update 2 figs and add 1 more (Data Mgmt)

* guide: roll back unrelated changes
per #4042 (review)

* guide: mention clouds first (DM) and

and update fig. 1
per #4042 (review)

* guide: flatten DM index
per #4042 (review)

* guide: udpates to DM/ DV
moved from #4053 (review)

* guide: add DM/ Data Versioning page

per #4042 (comment)

* guide: update outdated link

* guide: revert more unrelatedly chaqnged files

per #4042 (review)

* guide: remove unused ref link

* guide: DM/ Remote Storage (not just Setup) and

and some links from cmd refs
and avoid term "data remote"
and some admons nearby...

* guide: remove a comment

* guide: draft for DM/ Remote Storage content

* ref: expand config.remote and link to/from Remotes guide

* ref: fix remote config file examples

* guide: complete Remote Config section and

and add Project config section to DM/ DV guide

* ref: rewrite remote add and modify Descs

* guide: complete list of supported storage types

* ref: rewrite remote index page from

extracted from #4053

* guide: clarify `remote modify` phrase in

in the Remote config section of DM/ Remote Storage

* Update content/docs/user-guide/data-management/data-versioning.md

* guide: update versioning config

per #4058 (review)

* guide: don't call remote storage "additional" here

(in the DM/ Remote Storage guide)
per #4058 (review)

Co-authored-by: Dave Berenbaum <[email protected]>

* guide: pull -> download (DM/ RS intro)

* guide: remove "optional" from Remote Storage nav & title

per #4058 (review)

* guide: splits and notes around Data Mgmt index page

rel. #4042 (comment)

* guide: Data Mgmt intro + note updates

* guide: draft of all contents +

+ remove comments

* guide: small impros to Data Mgmt

in prep for #4042 (review)

* guide: rewrite Data Mgmt index in before/after form

per #4042 (review)

* guide: add draft figure for Data Mgmt

* guide: simplify/refocus data mgmt index

per #4042 (review)

* work around commented header bug

* guide: drop DM/ DV page

* guide: rewrite DM intro and

- hide benefits (for now)
- remove codification comment block

* guide: use DM table instead of figure for now

* guide: rewrite Data Mgmt story

* guide: add draft figures to Data Mgmt

* guide: simplify Data Mgmt story and benefits

* guide: remove unused images (DM)

* guide: update Data Mgmt figures (v1)

* guide: rewrite text of Data Mgmt index

* guide: update Data Mgmt figures

* guide: iterate on Data Mgmt again

* guide: update Data Mgmt figs

* guide: more supporting info about Data Mgmt

* guide: update figures (much more concrete) and

and matching text updates

* guide: edits to How it works (Data Mgmt)

* guide: update Data Mgmt figures

Rel. #4042 (comment)

* guide: emphaisze dataset versions in UG fig 1

Rel. #4042 (comment)

* guide: update Data Mgmt figures (with notes),

expand img captions,
and update text accordingly.

* guide: more updates to text and figure styles,

esp. to the first half
and comment some stuff out (temporary)

* guide: update figures and text (Data Mgmt) ...

Using a tabs toggle for the 2nd fig.

* guide: Data Management text (section 1)

finalized for this version of figures

* guide: Data Management (main text)

finalized for this version of figures

* guide: Data Management (secondary text)

pending diagram and code sample(s)

* guide: add DVC data mgmt technical diagram &

dummy sample CLI blocks

* guide: update Data Mgmt text

* guide: udpate text and 2nd figure (Data Mgmt)

* guide: draft 2nd and 3rd figures

* guide: rewrite Data Mgmt/ How it works &

and Benefits/ Tradeoffs

Probably still unfinished... Missing more data versioning info? See HTML comments.

* guide: update drafts of Data Mgmt figures 2, 3

* guide: Data Mgmt improvements and

hide the benefits list for now

* guide: separate from Data Mgmt work

Rel. #4042

* Apply suggestions from code review

* Merge branch main +

* ref: update links from API to Remotes guide

* guide: update links around Remote Storage and

and other updates to nearby Markdown (e.g. proper admons)

* Roll back unrelated changes

* Restyled by prettier (#4261)

Co-authored-by: Restyled.io <[email protected]>

* ref: bring cloud versioning copy edits of import-url

from
https://github.com/iterative/dvc.org/pull/4260/files#diff-ef95e18c4bd039757695065a23946dc27e28b4727ce07c670cdc096e34dbe3b3

* ref: clarify import-url with cloud versioning

per #4142 (review)

* ref: updates to import-url --version-aware and

update --rev

* ref: add import-url --version aware to Synopsis

per #4089 (comment)

* Restyled by prettier (#4266)

Co-authored-by: Restyled.io <[email protected]>

* Restyled by prettier (#4322)

Co-authored-by: Restyled.io <[email protected]>

* Update content/docs/command-reference/remote/modify.md

Co-authored-by: Oded Messer <[email protected]>

* Update content/docs/command-reference/remote/modify.md

Co-authored-by: Oded Messer <[email protected]>

* Update content/docs/command-reference/push.md

Co-authored-by: Oded Messer <[email protected]>

* yarn format-all

---------

Co-authored-by: Dave Berenbaum <[email protected]>
Co-authored-by: rogermparent <[email protected]>
Co-authored-by: restyled-io[bot] <32688539+restyled-io[bot]@users.noreply.github.com>
Co-authored-by: Restyled.io <[email protected]>
Co-authored-by: Oded Messer <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pmrowla pmrowla

Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: cases Content of /doc/use-cases C: guide Content of /doc/user-guide C: ref Content of /doc/*-reference ✨ epic Placeholder ticket for multi-sprint direction, use story, improvement p1-important Active priorities to deal within next sprints
Projects
No open projects
DVC
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Cloud versioning changes iterative/dvc.org
5 participants
@pmrowla @jorgeorpinel @dberenbaum @shcheklein @daavoo