Doc links: allow overriding the base url #1587
Open
Conversation
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
florian-sanders-cc
requested review from
Galimede,
HeleneAmouzou,
clara-layus-cc,
Copilot,
hsablonniere,
pdesoyres-cc and
roberttran-cc
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the URL generation system for developer hub and documentation links, enabling consumers to customize the base URLs. The changes extract URL generation helpers into a dedicated module and provide a public API for overriding the default base URL.
Key changes:
- Created a new
dev-hub-url.jsmodule withgetDocUrl(),getDevHubUrl(), andsetDevHubBaseUrl()functions - Renamed
generate...Urlhelpers toget...Urland moved them fromutils.jsto the new module - Updated all references throughout the codebase to use the new import paths and function names
- Added comprehensive documentation for contributors and consumers
Reviewed Changes
Copilot reviewed 40 out of 40 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
src/lib/dev-hub-url.js |
New module implementing URL generation with customizable base URL |
src/lib/utils.js |
Removed URL generation functions (moved to dev-hub-url.js) |
test/utils.test.js |
Removed URL generation tests (moved to resource-urls.test.js) |
test/resource-urls.test.js |
Added comprehensive tests for URL generation and base URL customization |
src/translations/translations.*.js |
Updated imports and function calls to use new module |
src/components/*/*.js |
Updated imports and function calls across all components |
src/stories/fixtures/*.js |
Updated imports and function calls in fixture files |
docs/getting-started/custom-base-urls.md |
New documentation for consumers on customizing base URLs |
docs/contributing/urls.md |
New documentation for contributors on using URL helpers |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
- Rename `generateDevHubHref` to `getDevHubUrl` and move to `src/lib/dev-hub-url.js` - Rename `generateDocsHref` to `getDocUrl` and move to `src/lib/dev-hub-url.js` - Expose public `setDevHubBaseUrl` so that consumers of this project may change the base URL used for dev hub & doc links. Fixes #1579
florian-sanders-cc
force-pushed
the
doc-links/allow-overriding-base-url
branch
from
441d475 to
73d5627
Compare
🧐 Visual tests report for PR #1587The latest visual tests report is available. Please review the results.
1 components impacted
This comment was generated automatically by the Visual tests workflow. |
- Rename assets-url.test.js to `resource-urls.test.js`, - Add tests for `getDevHubUrl`, `getDevHubUrl`, and `setDevHubBaseUrl` based on the already existing assets URL tests. Fixes #1579
- Replace all occurrences of `generateDocsHref` with `getDocUrl`, - Replace all occurrences of `generateDevHubHref` with `getDevHubUrl`, - Change import paths from `utils.js` to `dev-hub-url.js`, - Remove all trailing slashes. Fixes #1579
Add a new guide explaining how to correctly generate documentation, developer hub, and asset URLs using helper functions. Includes usage examples, translation file integration, and best practices for avoiding hardcoded URLs.
Add a new documentation page explaining how to override the default developer hub and assets base URLs in Clever Cloud components. Includes usage examples for `setDevHubBaseUrl` and `setAssetsBaseUrl`, and highlights the importance of configuring URLs before importing components.
florian-sanders-cc
force-pushed
the
doc-links/allow-overriding-base-url
branch
from
73d5627 to
19b2ba9
Compare
|
🔎 A preview has been automatically published : https://clever-components-preview.cellar-c2.services.clever-cloud.com/doc-links/allow-overriding-base-url/index.html. This preview will be deleted once this PR is closed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #1579
What does this PR do?
src/lib/dev-hub-url.jsfile,generate...Urltoget...Urland moves them fromsrc/lib/utils.jstosrc/lib/dev-hub-url.js,get...Urlhelpers, and getting started for theset...Urlhelpers).How to review?