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(doc): Fix broken links to zebra_network and zebra_state Config structs on doc.zebra.zfnd.org #7838

Merged
merged 3 commits into from Oct 27, 2023

Conversation

teor2345
Copy link
Contributor

@teor2345 teor2345 commented Oct 26, 2023

Motivation

What are the most important goals of the ticket or PR?

This PR fixes broken links to the zebra_network and zebra_state Config structs in https://doc.zebra.zfnd.org/zebrad/config/struct.ZebradConfig.html

Close #7048

PR Author Checklist

Check before marking the PR as ready for review:

  • Will the PR name make sense to users?
    • Does it need extra CHANGELOG info?
    • Does the PR have a priority label?
  • Have you added or updated tests?
  • Is the documentation up to date?

This PR doesn't change Rust code behaviour, just the generated doc links.

Solution

  • Use full paths to config imports to avoid a doc link bug

Related:

  • Exclude zebra-test from the external docs build

Testing

I manually tested this locally with the doc build command we use in CI, and checked the files for zebra_network/zebra_network and zebra_state/zebra_state.

Review

This is a routine fix.

The generated docs from this PR should be checked for broken links in https://doc.zebra.zfnd.org/zebrad/config/struct.ZebradConfig.html

The "Deploy external docs to firebase" step logs a preview URL with the docs from each PR.

Reviewer Checklist

Check before approving the PR:

  • Does the PR scope match the ticket?
  • How do you know it works? Do the tests cover the PR motivation?
  • Are there any blockers to merging this PR?
    • Can some changes go in new tickets or PRs?
  • Manually test the PR

And check the PR Author checklist is complete.

Follow Up Work

If this happens again we should just link to docs.rs, it doesn't have this bug:

@teor2345 teor2345 added C-bug Category: This is a bug A-docs Area: Documentation P-Medium ⚡ I-usability Zebra is hard to understand or use labels Oct 26, 2023
@teor2345 teor2345 self-assigned this Oct 26, 2023
@teor2345 teor2345 requested review from a team as code owners October 26, 2023 00:23
@teor2345 teor2345 requested review from oxarbitrage and removed request for a team October 26, 2023 00:23
@github-actions github-actions bot added the C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG label Oct 26, 2023
Copy link
Contributor

@arya2 arya2 left a comment

Choose a reason for hiding this comment

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

Looks good!

mergify bot added a commit that referenced this pull request Oct 27, 2023
@mergify mergify bot merged commit 920ee14 into main Oct 27, 2023
157 checks passed
@mergify mergify bot deleted the config-links branch October 27, 2023 01:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation C-bug Category: This is a bug C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG I-usability Zebra is hard to understand or use
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Broken link to zebra_network and zebra_state Config in docs
2 participants