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

Documentation bug leading to 404 for unit tests #20802

Closed
s01ipsist opened this issue Jul 7, 2024 · 1 comment · Fixed by #20819
Closed

Documentation bug leading to 404 for unit tests #20802

s01ipsist opened this issue Jul 7, 2024 · 1 comment · Fixed by #20819
Labels
type: bug A code related bug.

Comments

@s01ipsist
Copy link

A note for the community

  • Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
  • If you are interested in working on this issue or have submitted a pull request, please leave a comment

Problem

https://vector.dev/docs/reference/vrl/
has a malformed hyperlink in the text

When writing [unit tests](https://vector.dev/docs/reference/configuration//unit-tests)

due to a double slash in the path which causes a 404 when following the link.

The source link in https://github.com/vectordotdev/vector/blob/master/website/cue/reference/remap/concepts/assertions.cue#L13
uses the lookup from
https://github.com/vectordotdev/vector/blob/master/website/cue/reference/urls.cue#L631

vector_configuration ends in a / but vector_unit_tests also uses a slash to separate the components of "\(vector_configuration)/unit-tests"

There are many values in this file which use the /docs/reference/configuration path, but only vector_unit_tests tries to use the vector_configuration reference. Suggest that this is standardised to

vector_unit_tests:                          "/docs/reference/configuration/unit-tests"

for consistency and to fix the 404

Configuration

No response

Version

0.39.0

Debug Output

No response

Example Data

No response

Additional Context

No response

References

No response

@s01ipsist s01ipsist added the type: bug A code related bug. label Jul 7, 2024
jszwedko added a commit that referenced this issue Jul 8, 2024
Closes: #20802

Signed-off-by: Jesse Szwedko <[email protected]>
@jszwedko
Copy link
Member

jszwedko commented Jul 8, 2024

Thanks! I opened #20819 to fix this.

github-merge-queue bot pushed a commit that referenced this issue Jul 8, 2024
ym pushed a commit to ym/vector that referenced this issue Aug 18, 2024
AndrooTheChen pushed a commit to discord/vector that referenced this issue Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: bug A code related bug.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants