Caution against dynamic prettyurls
#2402
Merged
Conversation
This file contains 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
|
Just a proposal to get things started. I have no particular attachment to any of the text. Feel free to tell me to change something, or directly push to the branch with whatever text you like. |
We should steer people away from using
prettyurls = get(ENV, "CI", nothing) == "true"
(or even `prettyurls = false`) and towards using `LiveServer`.
It is best to have a consistent setting and to always use a webserver
when viewing documentation locally. This avoids situations where there
might be subtle difference with `prettyurls=true` or `prettyurls=false`
and the documentation might work correctly when viewed locally, but be
subtly broken (without an error message!) when deploying on GitHub
Action. One such situation is a `@raw` block that references a local
image. The correct relative path of that image would be different
depending on the `prettyurls` setting.
goerz
force-pushed
the
mg/prettyurls-docs
branch
from
face7ff to
f8bd6ba
Compare
|
I'm actually kinda leaning towards just removing the suggestion. Or maybe putting it in a |
goerz
force-pushed
the
mg/prettyurls-docs
branch
from
34cc080 to
636089d
Compare
goerz
force-pushed
the
mg/prettyurls-docs
branch
from
636089d to
8d0dec7
Compare
|
Sounds good! Updated to https://documenter.juliadocs.org/previews/PR2402/man/guide/#Building-an-Empty-Document |
mortenpi
reviewed
Jan 26, 2024
mortenpi
approved these changes
Jan 26, 2024
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.
We should steer people away from using
(or even
prettyurls = false) and towards usingLiveServer.It is best to have a consistent setting and to always use a webserver when viewing documentation locally. This avoids situations where there might be subtle difference with
prettyurls=trueorprettyurls=falseand the documentation might work correctly when viewed locally, but be subtly broken (without an error message!) when deploying on GitHub Action. One such situation is a@rawblock that references a local image. The correct relative path of that image would be different depending on theprettyurlssetting.Closes #2395