This repository has been archived by the owner on Oct 16, 2024. It is now read-only.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
GTO: updating docs #235
GTO: updating docs #235
Changes from 11 commits
cd29ec5
a0be61a
6ef1d66
0ae8ca1
0de375e
bfe35b9
65d44d9
6d7c9c3
0a9515f
cda61d7
bcc2e14
b01f575
87fd4f6
8ef5e89
74e9c9c
fcce000
baf36fc
1d9aeb8
d799b92
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
This file was deleted.
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we need this section at all: it's DVC documentation (redundant since we already linked to the Get Started)...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But, this tells the bare minimum so people could understand the full workflow. DVC GS is quite huge, so just redirecting there without any context would be confusion. Do you disagree?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Besides, this shows
dvc import-url
, which could be an important scenario for some folks starting to use MR while having some models outside.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
People without context will get the bare minimum from this part. People with context will just see some story here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
WDYT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that linking to https://dvc.org/doc/start/data-management/data-versioning or even straight to https://dvc.org/doc/command-reference/add would be acceptable.
Not a super strong opinion since this section is small, but I think that in principle we should not cross-document products. Logic: what if the DVC feature changes? dvc.org/doc will probably get updated, but not here.
Not seeing why that's particularly important. BTW, the blocks are missing
git add .gitignore
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
... Instead, just link to DVC docs for specific operations of relevance, like this:
p.s. remember to try and use the commands in-line at least once (not just in fenced code blocks) so they get auto-linked (to the cmd ref).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor but I'm a bit worried about the use of term annotation here (and in
gto annotate
) given that Git tags also have annotations AND since we specifically use annotated Git tags only. May be confusing (esp. for users familiar with Git tags).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep. Don't remember why we decided on using "annotations" considering this collision.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But it's really the tag's annotation message that has a format right? Not all tags are annotated in Git (in fact it's rare to use annotated tags, I think) so this could be confusing/misleading wording.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, it's Git tag name. E.g. to register a version, you need a Git tag called
[email protected]
, annotated with some message. It could be annotated with any text, but without a text annotation it would be alightweight
tag, not anannotated
one (and GTO ignoreslightweight
tags). For example, see https://github.com/iterative/example-gto/tags[email protected]
is a tag name andRegistering artifact churn version v3.1.1
is a Git tag message.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see. May I ask why does GTO ignore lightweight tags?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, we had a discussion about it here iterative/gto#127