Remove Netlify stuff, follow up to #545

[stevepiercy]

• Sort and remove duplicate entries in pyproject.toml
• Remove unused docs requirements.
• Fix comments and remove unnecessary steps from tox.ini.
• Enable copy button for code blocks.
• Add linkcheck to documentation of documentation.

Refs: #545

---

📚 Documentation preview 📚: https://ploneapi--546.org.readthedocs.build/

[mister-roboto]

@stevepiercy 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!

[stevepiercy]

I am not familiar with .meta.toml and its usage, but there has been some drift between it and I guess pyproject.toml. I'm not sure what to do about that. I'd appreciate any direction.

[stevepiercy]

Do we use the docs tox environment for Jenkins or any other purpose? I'd like to delete it from tox.ini if it is not needed.

[stevepiercy]

@jenkins-plone-org please run jobs

[davisagli]

I am not familiar with .meta.toml and its usage, but there has been some drift between it and I guess pyproject.toml. I'm not sure what to do about that. I'd appreciate any direction.

@stevepiercy This package, like many core Plone packages, uses a standard set of configuration files generated by https://github.com/plone/meta/ ...that means that these files (including pyproject.toml, tox.ini, and others) should not be updated directly, but by updating .meta.toml and then re-running the config-package.py script in plone/meta (or else your changes will be wiped out the next time someone does that). If changes are needed to things that can't yet be controlled by the configuration, we can either update the template files in plone/meta (if it should apply to all packages) or add a setting there (if it really needs to be configurable per package).

[stevepiercy]

updating .meta.toml and then re-running the config-package.py script in plone/meta
(snip)
If changes are needed to things that can't yet be controlled by the configuration, we can either update the template files in plone/meta (if it should apply to all packages) or add a setting there (if it really needs to be configurable per package).

I think these settings changes are local only, not worth applying to all repos that use meta. I can run the script to run a diff and verify, and iterate until it's clean, before I commit and push.

I need to have a little more guidance so I don't mess up. The plone/meta README.md is not clear to me. Here's what I think I understand to be the process. Please let me know.

1. git clone https://github.com/plone/meta.git && cd meta. (Maybe this step is stupid obvious to a current meta user, but it's not explicitly published in the readme or Plone 6 Documentation, which might be a good addition to the Admin Guide. Maybe if it said "local clone of a repository", instead of "a given repository"?)
2. Update plone.api/.meta.toml with the settings I added to tox.ini and other files, adapting them to Python.
3. Follow Quick Start, substituting a valid local path to plone.api.
4. Repeat step 2 and running the script in step 3, until the script generates correct files.
5. Commit and push.
6. Profit!

[gforcada]

@stevepiercy the steps you mentioned are good, if there are improvements on the docs over there, that would be nice to get a PR with them :)

There's plenty of work to be done on plone/meta to make it easier to use, lack of manpower (from my side) has been the blocker for those.

[gforcada]

LGTM

[stevepiercy]

@stevepiercy the steps you mentioned are good, if there are improvements on the docs over there, that would be nice to get a PR with them :)

@gforcada thanks for the confirmation.

I'll create a PR in documentation, a new page under Developer guide. It will consist of an introduction of what meta is, with minimal usage docs for how to get started and links to details for routine tasks. I don't want to duplicate your work.

I think that, because meta is not mentioned anywhere in the Plone 6 Documentation, it is not well known outside the small circle of people who maintain a few Plone Python projects. When I first heard it mentioned, I thought, "Meta? Facebook is evil!" 🤡

[stevepiercy]

I'm going to move these changes into .meta.toml, so please don't merge yet. Set to draft for the time being.

[stevepiercy]

I made sure that my changes would be preserved when running meta on this repo in the future. One more review, please, and then I think it's good to merge.

[stevepiercy]

The failing test for Plone 6.0 on Python 3.8 is not the result of this PR. Plus we dropped support for that combination October 2024. We should remove that in a separate PR.

[gforcada]

@stevepiercy I dropped that combination in #553 , if you rebase this branch it should get a nice green check mark 😄

[stevepiercy]

I just enabled the Always suggest updating pull request branches option in this repo. Now a button appears Update branch, so I don't have to leave GitHub.

We'll see if it passes. I'll merge when green. Thanks @gforcada!

[stevepiercy]

@jenkins-plone-org please run jobs