WIP: add glossary with some basic DVC terms #431

algomaster99 · 2019-06-11T00:53:46Z

This PR just initializes the glossary. Suggestions for more terms and concepts, to be included here, are more than welcome!

Fixes #424

static/docs/user-guide/glossary.md

shcheklein

@algomaster99 let's first discuss on Discord what exactly and how do we want this doc to be structured. How will we be aligning it with the Basic concepts ticket for the user guide.

static/docs/commands-reference/version.md

src/Documentation/glossary.json

shcheklein

Looks great! Still some work has to be done. Fix Z-index + check the comments I left.

Also, it's not 100% clear how are we going to reconcile two separate files - one of them for longer description one for small snippets that have a link to the longer version?

algomaster99 · 2019-06-19T07:07:42Z

@shcheklein I think we can delete glossary.md and generate it using the json file instead.

src/Documentation/glossary.json

src/Documentation/sidebar.json

static/docs/user-guide/glossary.md

algomaster99 · 2019-06-24T09:10:45Z

@jorgeorpinel @shcheklein
Here the changes I have made till now:

The issue with z-index has been resolved by controlling the direction it pops in.
The enun (pronunciation) has been removed.
The content is rendered as markdown in the tooltip.

shcheklein

Please, address a few comments that are still not addressed.

Let's remove the glossary.md file for now altogether. If we have a JS we can reference in the documentation contributing guide it should be enough, especially if we use to show those tool tips.

There should be a section or a few sections called Basic Concepts in the user guide that is properly on a user level language explains some missing concepts. The glossary tooltips could point to these sections among other things.

algomaster99 · 2019-07-18T20:34:29Z

@jorgeorpinel @shcheklein

src/Tooltip/index.js

shcheklein

Looks awesome! Glad that SO helped after all. Just a couple questions from me and @jorgeorpinel . Please take a look. Please run it on different browsers, make sure that we don't break mobile (even if we don't show tooltips there yet).

algomaster99 · 2019-07-19T07:29:59Z

@jorgeorpinel @shcheklein
Yeah, you can upvote it. There is only one answer :)
Please review as well. I have made some changes.

algomaster99 · 2019-07-19T08:03:44Z

@shcheklein It is currently not designed for the mobile view so it is breaking a little - like it can go off-screen, etc.

jorgeorpinel · 2019-07-19T20:34:01Z

@algomaster99

currently not designed for the mobile view so it is breaking a little

~~Did you ever open a separate issue to address the mobile view? Or add it to the existing future issue #461 please.~~

Nevermind, I just moved all the missing stuff from this PR to that issue.

shcheklein · 2019-07-19T22:10:59Z

@algomaster99 one more comment left to address (specify that .dvc/cache is the default location) + can we disable it on mobile if it breaks?

shcheklein

See the last comment from me.

algomaster99 · 2019-07-20T08:10:36Z

@jorgeorpinel @shcheklein I have made the changes. You can look at it :)

shcheklein

Awesome! 🎉

algomaster99 requested review from jorgeorpinel and shcheklein June 11, 2019 00:53

shcheklein temporarily deployed to dvc-org-pr-431 June 11, 2019 00:53 Inactive

shcheklein reviewed Jun 11, 2019

View reviewed changes

static/docs/user-guide/glossary.md Outdated Show resolved Hide resolved

shcheklein reviewed Jun 11, 2019

View reviewed changes

static/docs/user-guide/glossary.md Outdated Show resolved Hide resolved

shcheklein reviewed Jun 11, 2019

View reviewed changes

static/docs/user-guide/glossary.md Outdated Show resolved Hide resolved

jorgeorpinel changed the title ~~Add glossary with some basic DVC terminologies~~ WIP: add glossary with some basic DVC terms Jun 11, 2019

shcheklein requested changes Jun 11, 2019

View reviewed changes

This comment has been minimized.

Sign in to view

algomaster99 force-pushed the glossary branch from 6470c05 to 84129ee Compare June 18, 2019 13:36

This comment has been minimized.

Sign in to view

algomaster99 requested a review from shcheklein June 18, 2019 13:46

This comment has been minimized.

Sign in to view

shcheklein reviewed Jun 19, 2019

View reviewed changes

static/docs/commands-reference/version.md Show resolved Hide resolved

shcheklein reviewed Jun 19, 2019

View reviewed changes

src/Documentation/glossary.json Outdated Show resolved Hide resolved

shcheklein reviewed Jun 19, 2019

View reviewed changes

src/Documentation/glossary.json Outdated Show resolved Hide resolved

shcheklein reviewed Jun 19, 2019

View reviewed changes

src/Documentation/glossary.json Outdated Show resolved Hide resolved

shcheklein requested changes Jun 19, 2019

View reviewed changes

jorgeorpinel reviewed Jun 20, 2019

View reviewed changes

src/Documentation/glossary.json Outdated Show resolved Hide resolved

jorgeorpinel reviewed Jun 20, 2019

View reviewed changes

src/Documentation/sidebar.json Outdated Show resolved Hide resolved

jorgeorpinel reviewed Jun 20, 2019

View reviewed changes

static/docs/user-guide/glossary.md Outdated Show resolved Hide resolved

algomaster99 force-pushed the glossary branch from 84129ee to f0931e8 Compare June 24, 2019 09:02

This comment has been minimized.

Sign in to view

algomaster99 requested review from jorgeorpinel and shcheklein June 24, 2019 09:30

shcheklein requested changes Jun 24, 2019

View reviewed changes

This comment has been minimized.

Sign in to view

algomaster99 added 5 commits July 17, 2019 16:20

Use js file for glossary for better formatting of code

87cf864

Underline keywords instead of showing a symbol

93a8726

Rewrite workspace directory description

6343214

Add data artifact term in glossary

0372694

Toogle position of tooltip vertically

99d9e73

algomaster99 force-pushed the glossary branch from a9e6b3a to 99d9e73 Compare July 18, 2019 20:30

algomaster99 requested a review from shcheklein July 18, 2019 20:31

shcheklein temporarily deployed to dvc-org-pr-431 July 19, 2019 00:05 Inactive

This comment has been minimized.

Sign in to view

shcheklein reviewed Jul 19, 2019

View reviewed changes

src/Tooltip/index.js Outdated Show resolved Hide resolved

shcheklein requested changes Jul 19, 2019

View reviewed changes

algomaster99 added 2 commits July 19, 2019 12:43

Prevent rendering of tooltip if match is false

586fea6

Soft code height of header

9733399

shcheklein temporarily deployed to dvc-org-pr-431 July 19, 2019 07:27 Inactive

algomaster99 requested a review from shcheklein July 19, 2019 07:30

shcheklein requested changes Jul 19, 2019

View reviewed changes

algomaster99 added 2 commits July 20, 2019 13:37

Mention default location for cache directory

8360f06

Disable tooltip in mobile view

5ab1e96

algomaster99 requested a review from shcheklein July 20, 2019 08:08

shcheklein deployed to dvc-org-pr-431 July 20, 2019 08:08 View deployment

shcheklein approved these changes Jul 20, 2019

View reviewed changes

shcheklein merged commit 848467e into master Jul 20, 2019

algomaster99 deleted the glossary branch July 20, 2019 16:29

jorgeorpinel mentioned this pull request Aug 11, 2019

guide: new DVC Concepts section #550

Closed

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: add glossary with some basic DVC terms #431

WIP: add glossary with some basic DVC terms #431

algomaster99 commented Jun 11, 2019 •

edited by jorgeorpinel

Loading

shcheklein left a comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

shcheklein left a comment

algomaster99 commented Jun 19, 2019

algomaster99 commented Jun 24, 2019

This comment has been minimized.

shcheklein left a comment •

edited by jorgeorpinel

Loading

This comment has been minimized.

algomaster99 commented Jul 18, 2019

This comment has been minimized.

shcheklein left a comment

algomaster99 commented Jul 19, 2019

algomaster99 commented Jul 19, 2019

jorgeorpinel commented Jul 19, 2019 •

edited

Loading

shcheklein commented Jul 19, 2019

shcheklein left a comment

algomaster99 commented Jul 20, 2019

shcheklein left a comment

WIP: add glossary with some basic DVC terms #431

WIP: add glossary with some basic DVC terms #431

Conversation

algomaster99 commented Jun 11, 2019 • edited by jorgeorpinel Loading

shcheklein left a comment

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

shcheklein left a comment

Choose a reason for hiding this comment

algomaster99 commented Jun 19, 2019

algomaster99 commented Jun 24, 2019

This comment has been minimized.

shcheklein left a comment • edited by jorgeorpinel Loading

Choose a reason for hiding this comment

This comment has been minimized.

algomaster99 commented Jul 18, 2019

This comment has been minimized.

shcheklein left a comment

Choose a reason for hiding this comment

algomaster99 commented Jul 19, 2019

algomaster99 commented Jul 19, 2019

jorgeorpinel commented Jul 19, 2019 • edited Loading

shcheklein commented Jul 19, 2019

shcheklein left a comment

Choose a reason for hiding this comment

algomaster99 commented Jul 20, 2019

shcheklein left a comment

Choose a reason for hiding this comment

algomaster99 commented Jun 11, 2019 •

edited by jorgeorpinel

Loading

shcheklein left a comment •

edited by jorgeorpinel

Loading

jorgeorpinel commented Jul 19, 2019 •

edited

Loading