Skip to content
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

Translate validation error messages in the deserializer #1743

Merged
merged 8 commits into from
Jan 14, 2024

Conversation

wesleybl
Copy link
Member

Fixes #1742

Copy link

netlify bot commented Dec 22, 2023

Deploy Preview for plone-restapi canceled.

Name Link
🔨 Latest commit 35b71ed
🔍 Latest deploy log https://app.netlify.com/sites/plone-restapi/deploys/65a32dc13d33c30008d32cd2

@mister-roboto
Copy link

@wesleybl thanks for creating this Pull Request and helping to improve Plone!

TL;DR: Finish pushing changes, pass all other checks, then paste a comment:

@jenkins-plone-org please run jobs

To ensure that these changes do not break other parts of Plone, the Plone test suite matrix needs to pass, but it takes 30-60 min. Other CI checks are usually much faster and the Plone Jenkins resources are limited, so when done pushing changes and all other checks pass either start all Jenkins PR jobs yourself, or simply add the comment above in this PR to start all the jobs automatically.

Happy hacking!

@wesleybl
Copy link
Member Author

@jenkins-plone-org please run jobs

@davisagli
Copy link
Member

@jenkins-plone-org please run jobs

Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's try using the latest version of everything for docs in requirements.txt. Untested, but it follows the pattern in https://github.com/plone/training/blob/main/requirements.txt.

sphinxcontrib-devhelp==1.0.2 # newer versions require sphinx 5
sphinxcontrib-htmlhelp==2.0.1 # newer versions require sphinx 5
sphinxcontrib-qthelp==1.0.3 # newer versions require sphinx 5
sphinxcontrib-serializinghtml==1.1.5 # newer versions require sphinx 5
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really need all those sphinxcontrib-*helps?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stevepiercy Yes, they are dependencies of Sphinx. They released new versions yesterday which are not compatible with Sphinx<5, but no longer declare that in their package metadata.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean that we don't build those types of outputs, so why add them at all? We use only HTML and linkcheck.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stevepiercy And I meant that as far as I can tell, we don't have a choice, because they are pulled in by sphinx.

@davisagli davisagli merged commit 799f5ac into main Jan 14, 2024
25 checks passed
@davisagli davisagli deleted the translate_errors branch January 14, 2024 01:54
@stevepiercy
Copy link
Contributor

Here's a requirements-docs.txt that worked for me.

Sphinx
jsx-lexer
lesscpy
linkify-it-py
myst-parser
sphinx-autobuild
sphinx-book-theme
sphinx-copybutton
sphinx-sitemap
sphinx-togglebutton
sphinxcontrib.httpdomain
sphinxcontrib.httpexample
sphinxcontrib-spelling
sphinxext-opengraph

Also requires a change to conf.py:

    # "extra_navbar": """
    # <p class="ploneorglink">
    #     <a href="https://plone.org">
    #         <img src="/_static/logo.svg" alt="plone.org" /> plone.org</a>
    # </p>""",

This should work on RTD where docs get published. It will not affect pulling in docs into the main documentation.

@davisagli
Copy link
Member

@stevepiercy I didn't realize that the plone.restapi docs are still published separately at https://plonerestapi.readthedocs.io/

Do we really want that? (Doesn't it hurt SEO of the main docs?)

@stevepiercy
Copy link
Contributor

Prior to Plone 6, there was no automatic documentation deploy process, so RTD stood in for it. I can't find the discussion about removing them from RTD. IMO it is a bad idea to publish them to RTD for SEO, branding, Marketing, and additional maintenance. Someone objected to their removal from RTD, the reason for which I cannot recall, and I had no interest in pushing it.

@davisagli
Copy link
Member

@stevepiercy ok, I found the prior discussion about that: #1447

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Translate validation error messages
5 participants