[COPS-1524] Fix plugin logic and config schema #4
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
This is required because any configuration that doesn't match the default config schema (https://github.com/mkdocs/mkdocs/blob/1.0.4/mkdocs/config/defaults.py) will result in a warning being produced by mkdocs (which fails hard if strict mode is set). As per the mkdocs documentation, plugins should specify their own settings in as sub-objects in their `plugins:` section. While _technically_ the plugin does read the root-level `redirects:` config section, it should be using it at all. Note: this is technically a backwards-incompatible change. Any user who upgrades their installed plugin to this version will need to modify their config accordingly. As such, we should probably make a note of it in the release/version tag.
Prior to this commit, the logic being used here does not match the logic that MkDocs uses internally to generate the final site_dir. More specifically: we don't take into account the `use_directory_urls` setting at all, which alters how the site_dir is built (in regard to URLs and paths).
I'm bumping to version 1.0 because this release will contain backwards-incompatible changes.
|
No DRCODEOWNERS or CODEOWNERS file is found for this repository at master branch. |
brian-rickman
approved these changes
Aug 15, 2019
burkestar
approved these changes
Aug 15, 2019
|
Would one of you be able to push the new version to PyPi? Or grant me access ( |
|
I don't have the ability to grant you access on PyPi, but I pushed the new version. |
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.
https://datarobot.atlassian.net/browse/COPS-1524
Changes
Please see this branch's commit history for a list of changes and their explanations
Caveats
This contains breaking changes, and thus any users upgrading to this version will need to update their config.
Tested
I confirmed via manual testing that the new logic and config schema works as expected™️.
I'm defining "as expected" here as "in line with internal MkDocs behavior" and "in accordance with its documentation".
I confirmed that redirects work as expected with all combinations of the following settings:
use_directory_urlsset to bothtrueandfalse):index.mdto anyREADME.mdto anyarbitrary.mdto anyarbitrary.mdtohttp://google.com