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

chore: use the edit_url #7

Merged
merged 1 commit into from
Dec 2, 2024
Merged

chore: use the edit_url #7

merged 1 commit into from
Dec 2, 2024

Conversation

themr0c
Copy link
Contributor

@themr0c themr0c commented Dec 2, 2024

The "Edit this page" link should point to the GitHub repository.

See: https://docs.antora.org/antora/latest/playbook/content-edit-url/

If the page originates from the local filesystem (i.e., a worktree), the default UI uses the local file:// URI for the Edit this Page link. You can force the default UI to always use the edit URL by setting the CI environment variable (e.g., CI=true) when building the site. (This environment variable is already set in most CI environments). The assumption is that if the CI environment variable is set, the site is being published to a remote server where a file:// URI would not be accessible. Rather than setting this environment variable, you can customize the UI template to change the logic.

See: https://docs.antora.org/antora/latest/playbook/content-edit-url/

If the page originates from the local filesystem (i.e., a worktree), the default UI uses the local file:// URI for the Edit this Page link. You can force the default UI to always use the edit URL by setting the CI environment variable (e.g., CI=true) when building the site. (This environment variable is already set in most CI environments). The assumption is that if the CI environment variable is set, the site is being published to a remote server where a file:// URI would not be accessible. Rather than setting this environment variable, you can customize the UI template to change the logic.
@gbraad gbraad merged commit 0e29ee2 into crc-org:main Dec 2, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants