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

Update index.md add another QuickLink for HowTo Suggest edit #922

Closed

Conversation

acsr
Copy link
Contributor

@acsr acsr commented Jan 30, 2025

Please add a fourth option in the following menu and description: "HowTo Quick Link for Suggest edit"
full Tool-Type Text: Link to our Docs for using "Suggest edit" HowTo if you have already signed a Contributor Agreement.

See placeholder copy in the request. No actual code change added!


📚 Documentation preview 📚: https://plone-training--922.org.readthedocs.build/

**Please** add a fourth option in the following menu and description:
"HowTo Quick Link for **Suggest edit**"
full Tool-Type Text: Link to our Docs for using "Suggest edit" HowTo if you have already signed a Contributor Agreement.

See placeholder copy in the request. No actual code change added!
@acsr
Copy link
Contributor Author

acsr commented Jan 30, 2025

I missed to hit the draft button. Try to figure out how to set the state back. Until then this comment.

Submit a pull request. Optionally, if you want to mark your pull request as a "work in progress" that is not ready to merge or should be discussed further, you can convert it to a draft.

Need to find the option in the UI… lalala

@stevepiercy
Copy link
Contributor

This is not possible with the theme. Sorry.

@stevepiercy
Copy link
Contributor

stevepiercy commented Jan 30, 2025

I should mention that any and all pull requests require that the contributor either sign the PCA or post a statement, as specified in https://training.plone.org/contributing/index.html#granting-permission-to-publish. It's just not possible to do this in a menu item or in the theme. I am inclined to remove "Suggest edit" because it is intended for organizations that don't require such a thing as a PCA or copyright assignment.

@acsr
Copy link
Contributor Author

acsr commented Jan 30, 2025

I should mention that any and all pull requests require that the contributor either sign the PCA or post a statement, as specified in https://training.plone.org/contributing/index.html#granting-permission-to-publish. It's just not possible to do this in a menu item or in the theme. ...

This is not my intention!
With the "Suggest edit" link you are thrown directly into the edit process, that leads to a pull request without a chance to read these prerequisites and the additional hints for authors (my aim) When I hit "Suggest edit" I need to remeber the location where to look this up.

I understand your frustration confronted with pull requests, that do not meet the requirements. But this is life. You have to reject them unless you get some from e.g. me (who signed this). But you need to check it anyway.

It is two sided sword. Either:

  • Miss a vauleful hint, that can be transformed by the community into a regular contribution via an inbetween editor. Here the pain and the cure should be the target.
  • Have a convenient workflow with all the bells and whistles but you are alone waiting.
  • Be overrun by useless requests, which can be pain.

We already discussed this.
My thing is, that all the possible contributions that never see the light of the day are due to never ever finding the threads to connect to make it happen – Until you are an always nodding person that permanently says: I want this happen!

Heads up. I keep kicking.

@stevepiercy
Copy link
Contributor

The content of the PR does not make sense. I interpret it as content that should be submitted as an issue, not something that should be added to the documentation. I do not understand your intent here.

@acsr
Copy link
Contributor Author

acsr commented Jan 31, 2025

You are right. Actually it needs a PR in the Theme.

@stevepiercy stevepiercy deleted the acsr-patch-Add-additional-QuickLink-Suggest-edit-HowTo branch February 1, 2025 00:15
@stevepiercy
Copy link
Contributor

I would prefer a PR that implements boring-cyborg, same as I did for documentation, for first-time contributors. We don't want "Suggest edit" to go to "Contributing", which already exists in the left-hand navigation. It's not good UX to duplicate existing functionality, and I don't want to annoy the authors of the trainings who don't need to read Contributing guidelines.

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.

2 participants