Example not working: translation link in menu

[niccokunzmann]

According to the documentation, I should be able to add a link in to the language menu.

@@ -106,6 +106,10 @@ plugins:
             Hosting: Aufsetzen
             Development: Entwicklung
             News: Neuigkeiten
+        - locale: null
+          name: Help translating
+          build: false
+          fixed_link: https://spaceship-prompt.sh/contribute/?h=trans#Translating

If I do this, I get this error:

docs: commands[0]> mkdocs build
INFO    -  DeprecationWarning: warning_filter doesn't do anything since MkDocs 1.2 and will be removed soon. All messages on the `mkdocs` logger
           get counted automatically.
             File "/home/nicco/open-web-calendar/.tox/docs/lib/python3.11/site-packages/markdownextradata/plugin.py", line 8, in <module>
               from mkdocs.utils import warning_filter
             File "/home/nicco/open-web-calendar/.tox/docs/lib/python3.11/site-packages/mkdocs/utils/__init__.py", line 453, in __getattr__
               warnings.warn(
ERROR   -  Config value 'plugins': Plugin 'i18n' option 'languages': Sub-option 'locale': Required configuration not provided.

Aborted with 1 configuration errors!
docs: exit 1 (0.60 seconds) /home/nicco/open-web-calendar> mkdocs build pid=14595
  docs: FAIL code 1 (0.63=setup[0.03]+cmd[0.60] seconds)
  evaluation failed :( (0.69 seconds)

Versions:

$ .tox/docs/bin/pip list
Package                                   Version
----------------------------------------- -----------
Babel                                     2.14.0
beautifulsoup4                            4.12.3
cairocffi                                 1.6.1
CairoSVG                                  2.7.1
certifi                                   2024.2.2
cffi                                      1.16.0
charset-normalizer                        3.3.2
click                                     8.1.7
colorama                                  0.4.6
cssselect2                                0.7.0
defusedxml                                0.7.1
ghp-import                                2.1.0
gitdb                                     4.0.11
GitPython                                 3.1.43
idna                                      3.6
Jinja2                                    3.1.3
Markdown                                  3.6
MarkupSafe                                2.1.5
mergedeep                                 1.3.4
mkdocs                                    1.5.3
mkdocs-git-revision-date-localized-plugin 1.2.4
mkdocs-macros-plugin                      1.0.5
mkdocs-markdownextradata-plugin           0.2.5
mkdocs-material                           9.5.17
mkdocs-material-extensions                1.3.1
mkdocs-meta-descriptions-plugin           3.0.0
mkdocs-rss-plugin                         1.12.1
mkdocs-static-i18n                        1.2.2
packaging                                 24.0
paginate                                  0.5.6
pathspec                                  0.12.1
pillow                                    10.3.0
pip                                       24.0
platformdirs                              4.2.0
pycparser                                 2.22
Pygments                                  2.17.2
pymdown-extensions                        10.7.1
python-dateutil                           2.9.0.post0
pytz                                      2024.1
PyYAML                                    6.0.1
pyyaml_env_tag                            0.1
regex                                     2023.12.25
requests                                  2.31.0
setuptools                                69.2.0
six                                       1.16.0
smmap                                     5.0.1
soupsieve                                 2.5
termcolor                                 2.4.0
tinycss2                                  1.2.1
urllib3                                   2.2.1
watchdog                                  4.0.0
webencodings                              0.5.1
wheel                                     0.43.0

[ultrabug]

hi @niccokunzmann I'll have a look, sorry about that and the delay.

[ultrabug]

Quick fix, put "null" between quotes else it's interpreted as .. null :)

        - locale: "null"
          name: Help translating
          build: false
          fixed_link: https://spaceship-prompt.sh/contribute/?h=trans#Translating

[ultrabug]

in the linked MR above, I'm fixing the docs first

the locale setting is validated by MkDocs itself and defined as Locale(str) so it must indeed be a string.

I'll merge the doc update, sorry for the misleading mistake!