Skip to content

Link to Discourse first in "Help with Documentation" section #1043

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

Closed
wants to merge 1 commit into from

Conversation

Mariatta
Copy link
Member

@Mariatta Mariatta commented Feb 6, 2023

The Docs Discourse forum is the preferred way.
I reordered the sentence so that the discourse forum is mentioned first.

The Docs Discourse forum is the preferred way.
I reordered the sentence so that the discourse forum is mentioned first.
to the `Documentation category on the Python Discourse
<https://discuss.python.org/c/documentation/26>`_ and the `docs@python.org <https://mail.python.org/mailman3/lists/docs.python.org/>`_
mailing list where user issues are raised and documentation toolchain,
projects, and standards are discussed.
Copy link
Member

Choose a reason for hiding this comment

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

Whitespace nit for the linter:

Suggested change
projects, and standards are discussed.
projects, and standards are discussed.

Comment on lines +39 to +42
to the `Documentation category on the Python Discourse
<https://discuss.python.org/c/documentation/26>`_ and the `docs@python.org <https://mail.python.org/mailman3/lists/docs.python.org/>`_
mailing list where user issues are raised and documentation toolchain,
projects, and standards are discussed.
Copy link
Member

@CAM-Gerlach CAM-Gerlach Feb 6, 2023

Choose a reason for hiding this comment

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

Fix trailing whitespace (causing the lint failure), and fix line breaks to minimize diffs and keep the line lengths at least roughly consistent.

Suggested change
to the `Documentation category on the Python Discourse
<https://discuss.python.org/c/documentation/26>`_ and the `docs@python.org <https://mail.python.org/mailman3/lists/docs.python.org/>`_
mailing list where user issues are raised and documentation toolchain,
projects, and standards are discussed.
to the `Documentation category on the Python Discourse
<https://discuss.python.org/c/documentation/26>`_ and the
`docs@python.org <https://mail.python.org/mailman3/lists/docs.python.org/>`_ mailing list
where user issues are raised and documentation toolchain, projects, and standards
are discussed.

Copy link
Member

Choose a reason for hiding this comment

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

Hey @Mariatta , do we just want to commit this and merge, or do you have other ideas here? Thanks!

Copy link
Member

Choose a reason for hiding this comment

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

Because it seems the branch was mistakenly pushed to the upstream repo rather than the user's fork (as the user was an admin, the current protections against this didn't work—I've tested and confirmed an improved version on python/core-workflow#460 that would prevent accidents like this going forward), @Mariatta or one of her fellow admins will have to commit this suggestion.

@CAM-Gerlach CAM-Gerlach changed the title Update the "Help with Documentation" section Link to Discourse first in "Help with Documentation" section Feb 6, 2023
@safwansamsudeen
Copy link
Contributor

@Mariatta if you're busy right now, I'd love to take this up!

I have it here, and I'll submit a PR if this is closed - I'm not sure how I can contribute directly here.

I mean, it's a small change and you can easily do it yourself, but I'm new here and scrambling for issues to help with ;).

@CAM-Gerlach
Copy link
Member

Thanks for the offer @safwansamsudeen , but if @Mariatta 's busy, we can simply commit my suggestion here to achieve the same thing, without all the overhead of a whole other PR and without stripping author/attribution information.

However, your help on the other PR you commented would be much appreciated, and a new clean branch is indeed the approach that would be required there, if you're up for it. Thanks!

@Mariatta
Copy link
Member Author

Thanks for the ping and reminding me of this PR. I will take a look once I'm back on the computer.

Copy link
Member

@ezio-melotti ezio-melotti left a comment

Choose a reason for hiding this comment

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

PR LGTM with @CAM-Gerlach suggestion applied.

@safwansamsudeen
Copy link
Contributor

Thanks for the offer @safwansamsudeen , but if @Mariatta 's busy, we can simply commit my suggestion here to achieve the same thing, without all the overhead of a whole other PR and without stripping author/attribution information.

However, your help on the other PR you commented would be much appreciated, and a new clean branch is indeed the approach that would be required there, if you're up for it. Thanks!

Sounds good!

@Mariatta
Copy link
Member Author

I recreated the PR using my own fork in #1118.

@Mariatta Mariatta closed this Jun 12, 2023
@CAM-Gerlach
Copy link
Member

Okay, thanks. Did it not allow you to commit the above suggestion? I thought it would as an admin (since it allowed you to push initially), but maybe not.

Anyway, would you ,omd cleaning up these two stale branches, as well as the other two merged ones? The branches page lists all four, and you should be able to delete them with one click from there (assuming Allow deletion is enabled for the * branch protection rule, as it should be). This will unblock implementing the last remaining items from python/core-workflow#460. Thanks!

@ambv ambv deleted the Mariatta-patch-1 branch June 15, 2023 14:28
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.

5 participants