Skip to content

docs: fix broken anchors in HSM / tedge-p11-server docs#3638

Merged
reubenmiller merged 2 commits intothin-edge:mainfrom
reubenmiller:docs-hsm-links-and-format
May 22, 2025
Merged

docs: fix broken anchors in HSM / tedge-p11-server docs#3638
reubenmiller merged 2 commits intothin-edge:mainfrom
reubenmiller:docs-hsm-links-and-format

Conversation

@reubenmiller
Copy link
Copy Markdown
Contributor

Proposed changes

Fix some broken anchors in the tedge-p11-server reference guide which linked back to the HSM doc page.

Note: Using explicit anchor tags for section which are referenced on another page is preferred otherwise if the title is changed, then the reference also breaks.

In addition, some trailing whitespace was also removed from the HSM page, and a reference to thin-edge was replaced with the %%te%% variable.

The broken anchors were detected when building the tedge-docs locally:

Exhaustive list of all broken anchors found:
- Broken anchor on source page path = /thin-edge.io/next/references/tedge-p11-server/:
   -> linking to /thin-edge.io/next/references/hsm-support/#part-2-thin-edge-setup
- Broken anchor on source page path = /thin-edge.io/references/tedge-p11-server/:
   -> linking to /thin-edge.io/references/hsm-support/#part-2-thin-edge-setup

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue


Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s. You can activate automatic signing by running just prepare-dev once)
  • I ran just format as mentioned in CODING_GUIDELINES
  • I used just check as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

Signed-off-by: reubenmiller <reuben.d.miller@gmail.com>
Signed-off-by: reubenmiller <reuben.d.miller@gmail.com>
@reubenmiller reubenmiller temporarily deployed to Test Pull Request May 22, 2025 07:37 — with GitHub Actions Inactive
@reubenmiller reubenmiller added documentation Improvements or additions to documentation theme:hsm Hardware Security Module related topics labels May 22, 2025
@reubenmiller reubenmiller requested a review from Bravo555 May 22, 2025 07:37
@codecov
Copy link
Copy Markdown

codecov bot commented May 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

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

Approved

@github-actions
Copy link
Copy Markdown
Contributor

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
634 0 3 634 100 1h48m12.723915s

@reubenmiller reubenmiller added this pull request to the merge queue May 22, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks May 22, 2025
@reubenmiller reubenmiller added this pull request to the merge queue May 22, 2025
Merged via the queue into thin-edge:main with commit 286313f May 22, 2025
34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation theme:hsm Hardware Security Module related topics

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants