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.

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

cmd-ref: Document ls-url command #3996

Merged
merged 9 commits into from
Oct 10, 2022
Merged

cmd-ref: Document ls-url command #3996

merged 9 commits into from
Oct 10, 2022

Conversation

rlamy
Copy link
Contributor

@rlamy rlamy commented Sep 26, 2022

Document ls-url command, which is being implemented in iterative/dvc#8299.

Fixes #3992

In review app: https://dvc-org-dvc-ls-url-jhwjeyjd4mh.herokuapp.com/doc/command-reference/list-url

@shcheklein shcheklein temporarily deployed to dvc-org-dvc-ls-url-jhwjeyjd4mh September 26, 2022 17:00 Inactive
@github-actions
Copy link
Contributor

github-actions bot commented Sep 26, 2022

2d97b3f

Link Check Report

There were no links to check!

CML watermark

Copy link
Contributor

@dberenbaum dberenbaum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Just one minor typo.

@shcheklein
Copy link
Member

need to update syntax highlighter I think ... @rogermparent @yathomasi could you pls help / guide where and how it can be done pls?

@rogermparent
Copy link
Contributor

We've been working on the syntax highlighter, last I remember @yathomasi is on it right now and we're parked at a spot where we don't currently have a good way to grab/update the highlight definitions we share for dvc/cml/mlem since they're generated from the sidebar.json system and are difficult to share as a result. It's already pretty high priority, but we can bump it higher since it seems like the issue people are running into most.

@shcheklein shcheklein temporarily deployed to dvc-org-dvc-ls-url-jhwjeyjd4mh September 27, 2022 03:43 Inactive
@jorgeorpinel jorgeorpinel added A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/*-reference labels Sep 27, 2022
@yathomasi
Copy link
Contributor

For alias please update: https://github.com/iterative/dvc.org/blob/main/content/linked-terms.js
For the addition of new commands:
- we need to update respective command file here
- I did write a rough script to update the commands a while back expecting this same situation. Now, we can bump up to higher priority and I think we can update this into GHA to create PR with CML.

The one @rogermparent mentioned is for cross-websites command line linker. draft PR

We've been working on the syntax highlighter, last I remember @yathomasi is on it right now and we're parked at a spot where we don't currently have a good way to grab/update the highlight definitions we share for dvc/cml/mlem since they're generated from the sidebar.json system and are difficult to share as a result. It's already pretty high priority, but we can bump it higher since it seems like the issue people are running into most.

@shcheklein shcheklein temporarily deployed to dvc-org-dvc-ls-url-jhwjeyjd4mh September 28, 2022 20:53 Inactive
@dberenbaum dberenbaum added the ⌛ status: wait-core-merge Waiting for related product PR merge/release label Sep 30, 2022
@shcheklein shcheklein temporarily deployed to dvc-org-dvc-ls-url-jhwjeyjd4mh September 30, 2022 17:25 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-dvc-ls-url-jhwjeyjd4mh September 30, 2022 18:11 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-dvc-ls-url-jhwjeyjd4mh October 3, 2022 20:20 Inactive
@rlamy
Copy link
Contributor Author

rlamy commented Oct 5, 2022

dvc list-url has been merged. Could someone do a final review please?

@yathomasi Should I send a PR simply adding list-url to gatsby-theme-iterative?

@rogermparent
Copy link
Contributor

Thomas is on vacation, so I'll help you see this through. We're just adding ls-url and list-url to dvc, right? I opened up this PR for that. Sorry for not helping out for so long, I actually just glanced by a few times and assumed the issue was handled with the information.

@dberenbaum dberenbaum removed the ⌛ status: wait-core-merge Waiting for related product PR merge/release label Oct 6, 2022
Copy link
Contributor

@dberenbaum dberenbaum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. @rogermparent I approved iterative/gatsby-theme-iterative#89. Do you want to merge that first and then this one can be merged?

@yathomasi yathomasi temporarily deployed to dvc-org-dvc-ls-url-jhwjeyjd4mh October 10, 2022 13:09 Inactive
@yathomasi
Copy link
Contributor

The theme is updated and merged into this PR as well. The changes should be reflected on the preview deployment.

@rogermparent
Copy link
Contributor

image
From the preview 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/*-reference
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document dvc ls-url
6 participants