We are using the first way of specifying the switcher.json location, i.e. full url pointing to our website. Now I broke the json file, which did not cause any problem in the build pipeline but the switcher certainly did not work. However, when I tired to "repair" it, the build pipeline always broke (with a not very clear error message).
It took me quite a while to figure out what the problem was, namely that the json file that is checked, actually is the one already on the server (as specified in conf.py) and not the one in the local file system (we have switcher.json in the _static directory of the master branch).
I can switch of the check using the check_switcher option in conf.py, but maybe the documentation can be enhanced to make it clear, which file is actually checked.
Alternatively one could introduce an additinal parameter next to json_url specifying the local path to the file to be checked. I believe it makes more sense to check the version to be pushed than the one already in place.
We are using the first way of specifying the
switcher.jsonlocation, i.e. full url pointing to our website. Now I broke the json file, which did not cause any problem in the build pipeline but the switcher certainly did not work. However, when I tired to "repair" it, the build pipeline always broke (with a not very clear error message).It took me quite a while to figure out what the problem was, namely that the json file that is checked, actually is the one already on the server (as specified in
conf.py) and not the one in the local file system (we haveswitcher.jsonin the_staticdirectory of the master branch).I can switch of the check using the
check_switcheroption inconf.py, but maybe the documentation can be enhanced to make it clear, which file is actually checked.Alternatively one could introduce an additinal parameter next to
json_urlspecifying the local path to the file to be checked. I believe it makes more sense to check the version to be pushed than the one already in place.