-
Notifications
You must be signed in to change notification settings - Fork 6
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
feat: Support configurable display of version #80
Conversation
We use this plugin for all our docs. It is only on 1 repo where we want to remove the version (https://github.com/apache/incubator-pekko-site). Could we change this so the version display is configurable (on by default - but possible to use a config to disable it)? |
as an fyi, there has been discussion about not using paradox and this plugin for generating the top level pages in https://github.com/apache/incubator-pekko-site - switching to using another tool that is more suited for the static content that we want on these top level pages fyi @mdedetrich |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Am I missing something or is there supposed to be paradoxProperties += ("disabled.versioning.display" -> "true")
somewhere in the code, it seems you have only committed the resulting rendered site and forgot the actual config?
I still have this sentiment but I am not going to block changes like this over it |
@mdedetrich No, you are not missing anything. This PR using paradox boolean expression which selective display the versioning via config.
No config change because it enable display by default, And it will only be hidden in explicit configuration (such as repo An additional pull request is required for the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nvm I was being daft, lgtm
looks like it should work - I plan to test this on my laptop later (uptake in pekko-site repo) and can merge it if that test goes ok |
@pjfanning Thank you for testing. When the KV is not matching ("disabled.versioning.display" -> "true"), the hiding should also not work. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
Refs: apache/pekko-site#33
Then we can hidden page versioning on "top-level-page" of Pekko website, and still display by default for other project, all those stuff can switch via configuration.
usage
set it by specifying the flag in
build.sbt
example