concepts: workspace #2453
concepts: workspace #2453
Conversation
…ument to the links
expcet uses/implications part
added a BC: workspace document
|
Cc @iesahin in case you want to check out what I had in mind for this one or have any comments. |
|
Ok this is stale. Need to plan releasing several basic concepts in tandem... Closing for now |
|
Reopening per #2595 (comment) ⌛ |
| name: Workspace | ||
| match: [workspace] | ||
| tooltip: >- | ||
| Directory containing all your project files e.g. raw datasets, source code, ML | ||
| models, etc. Typically, it's also a Git repository. It will contain your DVC | ||
| project. | ||
| Directory containing all your DVC project files, e.g. raw data, source code, | ||
| ML models. One project version at a time is visible in the workspace. | ||
| See full [concept page](/doc/user-guide/basic-concepts/workspace). |
There was a problem hiding this comment.
Hi @julieg18 and @rogermparent: Is there a way to add a link property to the tooltip frontmatter structures (maybe afer tooltip)? So it links from here:
Instead of having to add a sentence with the link to the tooltip text (as in the code above). Thanks.
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
There was a problem hiding this comment.
I would think we'd want to automatically know the link and populate it without manually specifying it, but either way (or both if we want some override behavior) should work. @julieg18 may have more details, since she built out this feature.
There was a problem hiding this comment.
automatically know the link and populate it without manually specifying it
OK but the tricky part is that it should only link to the corresponding user-guide/basic-concepts/<name> page IF there's MD content in this same file (under the frontmatter). For now a manual link field is good enough and it can become the override later if we implement the auto-linking after that.
So should we make that change in this PR?
There was a problem hiding this comment.
Co-assigned with @julieg18 for now 🙂
There was a problem hiding this comment.
It should be possible to implement this! We can update the glossary.tsx to check for a link field and decide what to render. Do we want the "Workspace" to still have the same styling as the other tooltip titles(black with an icon that appears on hover) or do we want it to look like a link(blue with underline on hover)?
There was a problem hiding this comment.
Sounds good. Should look like a link but I guess also bold since it's the entry's title? Up to you
|
ah so https://dvc-org-concept-workspa-6kl6xs.herokuapp.com/doc/user-guide/basic-concepts/workspace renders fine (even though it's not in the ToC nav). Could address that (1. adding an auto-generated |
Yep. So for now no need to add menu entries at least until several pages are available. @julieg18 I'll link from the glossary texts for now and open a separate issue to auto-link from the names. Thanks |
|
p.s. another reason to have a Concepts menu or index besides linking from the Glossary is the order in which they're listed e.g. Workspace should be the among first as it's pretty basic but in the glossary is the last due to the automatic alphabetical order. |
Continues/addresses #2197
See https://dvc-org-concept-workspa-4abjdl.herokuapp.com/doc/user-guide/basic-concepts
dvc cmdlinks work from frontmatter after these changes, or create an issue (see docs: misc content & guide updates #2359 (review)). tooltips: auto-link todvc cmdfrom Frontmatter #2756Do we need the changes in package.json, src/components/Documentation/Markdown/Tooltip/index.tsx, src/gatsby/models/glossary/index.js, and src/utils/front/glossary.ts from https://github.com/iterative/dvc.org/pull/1944/files?May want to wait to merge this until there are more concept pages ready (as chained PRs perhaps)