Repository navigation
Docs: use relative links instead of docs.hubsfoundation.org - #257
Open
HussainAther wants to merge 1 commit into
Open
HussainAther wants to merge 1 commit into
HussainAther wants to merge 1 commit into
Conversation
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What?
Replaces hard-coded
https://docs.hubsfoundation.org/...links in a small set of documentation pages with relative links (e.g../beginners-guide-to-CE.html#...,./hubs-features.html, etc.) so links remain portable across different deployments/hosts.Files touched:
docs/how-to-backup-your-Hubs-instance.mddocs/dev-contributing.mddocs/dev-client-networking.mddocs/set-up-SMTP-email-service.mdWhy?
Examples
Before:
https://docs.hubsfoundation.org/beginners-guide-to-CE.html#12-generate-your-config-filehttps://docs.hubsfoundation.org/hubs-features.htmlAfter:
./beginners-guide-to-CE.html#12-generate-your-config-file./hubs-features.htmlHow to test
Run the docs site locally:
cd websitenpm ci(oryarnif that’s the repo standard)npm startOpen the affected pages and click the changed links:
Verify links still navigate correctly (including anchors like
#12-generate-your-config-file).Documentation of functionality
No functional behavior changes. This is documentation-only link formatting.
Limitations
https://docs.hubsfoundation.org/...links).Alternatives considered
Open questions
./page.htmllinks everywhere, or allow.md(since Docusaurus resolves both)?Additional details or related context
Related to ongoing discussion about standardizing hubs-docs internal link formatting (relative vs absolute) (e.g. issue #254 / link-style discussion).