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

fix automatic linking to dvc cmd subcmd #392

Closed
jorgeorpinel opened this issue May 30, 2019 · 3 comments
Closed

fix automatic linking to dvc cmd subcmd #392

jorgeorpinel opened this issue May 30, 2019 · 3 comments
Labels
A: docs Area: user documentation (gatsby-theme-iterative) p1-important Active priorities to deal within next sprints website: eng-doc DEPRECATED JS engine for /doc

Comments

@jorgeorpinel
Copy link
Contributor

Currently code blocks like dvc remote modify or dvc pkg install are converted to a link to the parent command reference, with an (often inexistent) # anchor to the subcommand (e.g. /doc/commands-reference/remote#modify)

Option 1: fix the automatic linking so the docs engine can link to subcommands correctly.

Option 2: change all references to subcommands in docs using regular md links (e.g. [dvc remote modify](/doc/commands-reference/remote-modify))

@shcheklein
Copy link
Member

Yep, we need to wait until this one is solved #305 because it will change the way we put URLs together.

@shcheklein shcheklein added A: docs Area: user documentation (gatsby-theme-iterative) website: eng-doc DEPRECATED JS engine for /doc p1-important Active priorities to deal within next sprints labels May 30, 2019
shcheklein referenced this issue Aug 9, 2019
@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Aug 10, 2019

So happy this is working now! Just maybe missing to update the dvc fenced code block CSS so the entire command is blue unlike now:

image

@shcheklein
Copy link
Member

So happy this is working now!

kudos @iAdramelk !

Just maybe missing to update the dvc fenced code block CSS so the entire command is blue unlike now

@jorgeorpinel yep, it's a separate small thingy :) let's create a ticket for this.

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) p1-important Active priorities to deal within next sprints website: eng-doc DEPRECATED JS engine for /doc
Projects
None yet
Development

No branches or pull requests

2 participants