Skip to content

Basic concepts with glossary overrides#1954

Merged
jeremydesroches merged 2 commits into
ug-basic-conceptsfrom
basic-concepts-with-glossary-overrides
Nov 19, 2020
Merged

Basic concepts with glossary overrides#1954
jeremydesroches merged 2 commits into
ug-basic-conceptsfrom
basic-concepts-with-glossary-overrides

Conversation

@rogermparent
Copy link
Copy Markdown
Contributor

This PR is #1944 with a commit that adds the ability to override a glossary's tooltip entry with a new MD frontmatter field, tooltip.
When tooltip is specified, it will be parsed at build-time and used as the content of the glossary tooltip- otherwise, the previous behavior is used and the MD body forms the tooltip.

content/docs/user-guide/glossary has been changed to show this feature off:

---
name: 'DVC Project'
match:
  [
    'DVC project',
    'DVC projects',
    project,
    projects,
    'DVC repository',
    'DVC repositories',
    repository,
    repositories,
  ]
tooltip: >-
  Initialized by running `dvc init` in the **workspace** (typically a Git
  repository). It will contain the [`.dvc/`
  directory](/doc/user-guide/dvc-files-and-directories), as well as `dvc.yaml`
  and `.dvc` files created with commands such as `dvc add` or `dvc run`.
---

Initialized by running `dvc init` in the **workspace** (typically a Git
repository). It will contain the
[`.dvc/` directory](/doc/user-guide/dvc-files-and-directories), as well as
`dvc.yaml` and `.dvc` files created with commands such as `dvc add` or
`dvc run`.

This page extends for a _while_, elaborating on what a DVC Project is in a way
where it doesn't make sense to put **all** this stuff in a tooltip.

@rogermparent rogermparent temporarily deployed to dvc-landing-basic-conce-vsntwc November 18, 2020 23:07 Inactive
@rogermparent rogermparent temporarily deployed to dvc-landing-basic-conce-vsntwc November 18, 2020 23:09 Inactive
@jeremydesroches jeremydesroches merged commit 0f99868 into ug-basic-concepts Nov 19, 2020
@jeremydesroches
Copy link
Copy Markdown
Contributor

Thanks @rogermparent ! I'll use it in #1944 and let you know if any issues.

@jorgeorpinel
Copy link
Copy Markdown
Contributor

Many thanks, @rogermparent ! We'll continue the discussion in #1944

@shcheklein shcheklein deleted the basic-concepts-with-glossary-overrides branch February 28, 2021 19:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants