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

#11652 migrate community doc page rst #11653

Merged

Conversation

JudgeGregg
Copy link
Contributor

Scope and purpose

Fixes #11652

Add a few words about why this PR is needed and what is its scope.

  • Migrate Twisted Community Page to RST from old Trac Wiki.

Add any comments about trade-offs (if any) made in this PR and the reasoning behind them.

  • Removed the old IRC channels dev/web and old MLs.

Add mentions of things that are not covered here and are planed to be done in separate PRs.

  • Still need to update the twisted.org site to link to the new RTD page.

Contributor Checklist:

This process applies to all pull requests - no matter how small.
Have a look at our developer documentation before submitting your Pull Request.

Below is a non-exhaustive list (as a reminder):

  • The title of the PR should describe the changes and starts with the associated issue number, like “#9782 Remove twisted.news. #1234 Brief description”.
  • A release notes news fragment file was create in src/twisted/newsfragments/ (see: Release notes fragments docs.)
  • The automated tests were updated.
  • Once all checks are green, request a review by leaving a comment that contains exactly the string please review.
    Our bot will trigger the review process, by applying the pending review label
    and requesting a review from the Twisted dev team.

@JudgeGregg
Copy link
Contributor Author

please review

Copy link
Member

@adiroiban adiroiban left a comment

Choose a reason for hiding this comment

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

Thanks. It is a great start.

For reference, the updated page is here

https://twisted--11653.org.readthedocs.build/en/11653/community.html


I think it is worth talking about our Gitter channel

This is the chat that is available in the bottom right corner of our docs

image


Gitter is using Matrix, and Matrix is using Twisted ... so I think this is a nice example of Twisted being used for real world applications

@JudgeGregg
Copy link
Contributor Author

I think it is worth talking about our Gitter channel

You're right, I should have thought about it myself :).

@JudgeGregg
Copy link
Contributor Author

please review

@chevah-robot chevah-robot requested a review from a team September 9, 2022 20:49
@adiroiban adiroiban merged commit 7fe3054 into twisted:trunk Sep 9, 2022
@adiroiban
Copy link
Member

Thanks for the update. Happy to see the docs get some attention and at the same time move important info from the wiki over the official docs.

If you have time, please consider doing a followup PR for https://github.com/twisted/twisted.github.io to get the main page link to the new doc page.

For the community info, I think we can link to the "latest" version of the docs - https://docs.twisted.org/en/latest/

No need to go for the "stable" version.

image

@JudgeGregg
Copy link
Contributor Author

Thank you for your patience :)
I'll do the PR for the website.

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

Successfully merging this pull request may close these issues.

Migrate twisted community doc page to RST/RTD
3 participants