Skip to content

fix issue 1979#2386

Closed
sijia-w wants to merge 1 commit intoapache:masterfrom
sijia-w:master
Closed

fix issue 1979#2386
sijia-w wants to merge 1 commit intoapache:masterfrom
sijia-w:master

Conversation

@sijia-w
Copy link
Copy Markdown
Contributor

@sijia-w sijia-w commented Jul 27, 2020

Fixes #1979

Fix the links for metrics and the configuration parameters.

Copy link
Copy Markdown
Contributor

@eolivelli eolivelli left a comment

Choose a reason for hiding this comment

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

it is not a good practice to use absolute HTTP URL
can you simply fix the relative link ?

@sijia-w
Copy link
Copy Markdown
Contributor Author

sijia-w commented Jul 28, 2020

@eolivelli The second link can be easily changed to a relative link. But the file pointed to by the first link is empty. site/docs/4.10.0/reference/metrics.md This is the path. Should I modify this file at the same time?

@sijia-w
Copy link
Copy Markdown
Contributor Author

sijia-w commented Jul 30, 2020

@sijie The file pointed to by the first link is empty. site/docs/4.10.0/reference/metrics.md This is the path. Should I modify this file at the same time? If so, what should be the content? Thank you.

@Jennifer88huang-zz
Copy link
Copy Markdown
Contributor

Jennifer88huang-zz commented Aug 13, 2020

Since v4.5.0, the metrics.md file in the reference folder has no content.
In v4.6.0, another metrics.md file is added in the admin folder, and add a link to the metrics.md in the reference folder, thus resulting in the link issue.
Here are two solutions:

  1. Add metrics reference info in the metrics.md file in the reference folder. I suggest that we do not use the same name for md file in one project.
  2. Remove the current link.

@Jennifer88huang-zz
Copy link
Copy Markdown
Contributor

BTW, would you add "Fixes" before "#1979", so when a PR is merged, the related issue will be closed automatically.

@sijia-w
Copy link
Copy Markdown
Contributor Author

sijia-w commented Aug 13, 2020

@jennifer88huang Thanks very much for your feedback. If we adopt option 1, what should be added? Or you prefer option 2?

@sijia-w
Copy link
Copy Markdown
Contributor Author

sijia-w commented Aug 17, 2020

@jennifer88huang Which option do you prefer? Shall we remove the link for metrics?

@Jennifer88huang-zz
Copy link
Copy Markdown
Contributor

@jennifer88huang Which option do you prefer? Shall we remove the link for metrics?

Yes, if no one could provide the whole content for metrics reference at the moment, just remove the link; if the content is ready, we can add it again.

@sijia-w
Copy link
Copy Markdown
Contributor Author

sijia-w commented Aug 20, 2020

@jennifer88huang Got it. Thanks. Will do soon.

@sijia-w sijia-w closed this Aug 20, 2020
eolivelli pushed a commit that referenced this pull request Nov 6, 2020
Fixes #1979 

The link for `Metrics` is broken. However, the `Metrics` file is empty. Therefore, I temporarily removed the link in all versions. The same problem happened to `configuration parameters`.

I closed pr #2386 as it brought changes from the master instead of a new branch.

Reviewers: Enrico Olivelli <eolivelli@gmail.com>

This closes #2400 from sijia-w/fix-1979, closes #1979
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.

Broken "metrics" link in documentation

3 participants