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: fix broken links in overview.md #3440

Merged
merged 4 commits into from
Mar 31, 2020
Merged

docs: fix broken links in overview.md #3440

merged 4 commits into from
Mar 31, 2020

Conversation

LexusH
Copy link
Contributor

@LexusH LexusH commented Mar 26, 2020

Fixed 2 broken links that were pointed out in #2814.

Fixes #2814.

Fixed 2 broken links
Copy link
Contributor

@stephanwlee stephanwlee left a comment

Choose a reason for hiding this comment

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

Thank you for the contribution.

Within this doc, there are two other places where the links are broken. Do you mind fixing them, too?

The other two are:

  • tensorboard/backend/application.py
  • DEVELOPMENT.md

@@ -311,15 +311,15 @@ method.

### Can I customize which lines appear in a plot?

Using the [custom scalars plugin](tensorboard/plugins/custom_scalar), you can
Using the [custom scalars plugin](https://github.com/tensorflow/tensorboard/tree/master/tensorboard/plugins/custom_scalar), you can
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you use a relative path? i.e., ../../../tensorboard/plugins/custom_scalar. Here and below

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure! I'll work on fixing the other two broken links you pointed out too!

Copy link
Contributor

Choose a reason for hiding this comment

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

Thank you! For context, the reason that we like relative links is that
they enable editors to cross-link. For instance, in Vim, I can just
press gf (go-file) with my cursor on the relative link and it’ll open
in my editor.

Fixed two additional broken links. Changed previous link fixes to have relative paths.
removed superfluous white space
docs/r1/overview.md Outdated Show resolved Hide resolved
docs/r1/overview.md Outdated Show resolved Hide resolved
Converted all 4 broken links to working relative links
Copy link
Contributor

@stephanwlee stephanwlee left a comment

Choose a reason for hiding this comment

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

Thanks a lot for quick back and forth! 🙇

@wchargin wchargin changed the title Update overview.md docs: fix broken links in overview.md Mar 31, 2020
@wchargin wchargin merged commit 4d015b2 into tensorflow:master Mar 31, 2020
bileschi pushed a commit to bileschi/tensorboard that referenced this pull request Apr 15, 2020
Fixed 2 broken links that were pointed out in tensorflow#2814.

Fixes tensorflow#2814.
bileschi pushed a commit that referenced this pull request Apr 15, 2020
Fixed 2 broken links that were pointed out in #2814.

Fixes #2814.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc: r1 overview's link to custom scalar is not useful
4 participants