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

docs: rename plot -> plots #1293

Merged
merged 3 commits into from
May 14, 2020
Merged

docs: rename plot -> plots #1293

merged 3 commits into from
May 14, 2020

Conversation

efiop
Copy link
Member

@efiop efiop commented May 14, 2020

Per iterative/dvc#3802

You may disregard these recommendations if you used the Edit on GitHub button from dvc.org to improve a doc in place.

❗ Please read the guidelines in the Contributing to the Documentation list if you make any substantial changes to the documentation or JS engine.

πŸ› Please make sure to mention Fix #issue (if applicable) in the description of the PR. This causes GitHub to close it automatically when the PR is merged.

Please chose to allow us to edit your branch when creating the PR.

Thank you for the contribution - we'll try to review it as soon as possible. πŸ™

@shcheklein shcheklein temporarily deployed to dvc-landing-plot-plots-9bmmtfj May 14, 2020 17:16 Inactive
@efiop
Copy link
Member Author

efiop commented May 14, 2020

Looks like I also need to rename images and .dvc/plot to .dvc/plots

@shcheklein shcheklein temporarily deployed to dvc-landing-plot-plots-9bmmtfj May 14, 2020 17:26 Inactive
@shcheklein shcheklein temporarily deployed to dvc-landing-plot-plots-9bmmtfj May 14, 2020 17:28 Inactive
@efiop
Copy link
Member Author

efiop commented May 14, 2020

Getting

#!/bin/bash -eo pipefail
yarn link-check-diff
yarn run v1.22.4
$ ./scripts/link-check-git-diff.sh
~/repo ~/repo
config/prismjs/dvc-commands.js:/dev/fd/63:OK
content/blog/2020-04-30-gsod-ideas-2020.md:/dev/fd/63:OK
content/blog/2020-05-04-dvc-3-years-and-1-0-release.md:/dev/fd/63:OK
content/docs/command-reference/plots/diff.md:/dev/fd/63:
 ERROR:404:https://dvc.org/doc/command-reference/plots
ERROR:1 failures
---
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

Exited with code exit status 1

seems like it is not picking up that the plots already exists? https://dvc-landing-plot-plots-9bmmtfj.herokuapp.com/doc/command-reference/plots

@efiop
Copy link
Member Author

efiop commented May 14, 2020

Also:

./img/plot_show_field.svg                        
./img/plot_show_json.svg                         
./img/plot_show_json_field.svg                   
./img/plot_diff_confusion.svg                    
./img/plot_auc.svg                               
./img/plot_show_confusion.svg                    
./img/plot_diff.svg                              
./img/plot_diff_workspace.svg                    
./img/plot_show.svg                              
./uploads/images/2020-05-04/dvc-plot.svg         
./uploads/images/2020-05-04/dvc-plot-scatter.svg 
./uploads/images/2020-02-17/freq_plot.svg        

should I rename these or it doesn't matter or there are some bad consequences (i dunno, maybe caching will be confused?)?

@efiop efiop requested review from pared and jorgeorpinel May 14, 2020 18:05
@jorgeorpinel
Copy link
Contributor

ERROR:404:https://dvc.org/doc/command-reference/plots

Yeah this is a known problem in the link checker I think, please ignore it for now. Cc @casperdcl

@jorgeorpinel
Copy link
Contributor

should I rename these

Good catch about the image files. I would say let's rename them. I don't think it causes any caching issue but maybe @shcheklein knows better.

@jorgeorpinel
Copy link
Contributor

Thanks! Please request my review again if/when the core repo PR is merged.

@shcheklein shcheklein temporarily deployed to dvc-landing-plot-plots-9bmmtfj May 14, 2020 19:30 Inactive
@shcheklein
Copy link
Member

should I rename these

not problems with caching or something, just rename and change links. But to be honest it is πŸ’… ... plot or plots for images names I think is not important :)

@shcheklein shcheklein temporarily deployed to dvc-landing-plot-plots-9bmmtfj May 14, 2020 19:47 Inactive
@efiop efiop requested a review from jorgeorpinel May 14, 2020 19:48
Copy link
Contributor

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

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

LGTM, please merge if/when the core repo PR is merged.

@efiop efiop merged commit dc0cb53 into master May 14, 2020
@efiop efiop changed the title [WIP] docs: rename plot -> plots docs: rename plot -> plots May 14, 2020
@shcheklein shcheklein deleted the plot_plots branch February 28, 2021 19:36
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.

None yet

3 participants