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

#11683 migrate sponsor doc page rst #11684

Closed

Conversation

JudgeGregg
Copy link
Contributor

@JudgeGregg JudgeGregg commented Sep 23, 2022

Scope and purpose

Fixes #11683

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

  • Migrate Twisted Sponsors page to RST from old Trac Wiki.

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

  • So far I only added the founding sponsors. If we want to add "current" sponsors that's easy to do but I'm not sure they're relevant anymore.

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:

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

  • 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

@JudgeGregg JudgeGregg changed the title #11683 migrate sponsor doc page rst #11683 migrate sponsor doc page rst Sep 23, 2022
@JudgeGregg
Copy link
Contributor Author

please review

@chevah-robot chevah-robot requested a review from a team October 7, 2022 07:53
@adiroiban
Copy link
Member

Thanks for the PR.

Just a helper for people reviewing this

The main page (kind of empty) is at https://twisted--11684.org.readthedocs.build/en/11684/sponsors/index.html

An extra "old sponsors" page is at https://twisted--11684.org.readthedocs.build/en/11684/sponsors/foundingsponsors.html


I am -1 for this change in twisted/twisted.

It looks less like documentation and more like something that we should have on the main website https://github.com/twisted/twisted.github.io


I hope that @glyph can help and provide feedback on whether we want to keep "archeological" information in our documentation.


Now it doesn't mean that this should not be part of the documentation, and if other Twisted devs want to have this info in the docs, I would not oppose it.

Regards

@JudgeGregg
Copy link
Contributor Author

Thank you for the review.

Fair enough, it makes sense :)
I'm also migrating the success stories and projects pages. I imagine it should be considered "archeological" docs too ?
There is a "historical documents" section in the current doc. Would it be possible to host all those pages there ?

@adiroiban
Copy link
Member

I don't know what is the policy for "Historical document"

The page starts with "Here are documents which contain no pertinent information or documentation."


I am kind of -1 for adding any historical info the docs.

I think that we can leave this info archived inside https://github.com/twisted/trac-wiki-archive , as it already is.

We don't have/need to migrate the whole wiki to the documentation.


it can just pop in the searches, and confuse people.

I would rather just create a https://github.com/twisted/historic repo and place all the fiels there...

Which we should do, since the links are broken

@glyph
Copy link
Member

glyph commented Oct 7, 2022

I don't know what is the policy for "Historical document"

Yeah I don't think we have any particular policy.

@glyph
Copy link
Member

glyph commented Oct 7, 2022

I am kind of -1 for adding any historical info the docs.

At one point in the past I believed almost religiously in never breaking links for any reason and keeping every document available forever, but many years of experience later I think that having outdated information available and easily searchable mostly just confuses people. We can keep historical documents for historical interest on the internet archive's wayback machine, no need to keep them online on our site and repo forever.

@JudgeGregg
Copy link
Contributor Author

Thank you for your review :)

I've just opened:
#11714
to remove the historical docs from RTD.

Only one question remaining: the current website has links to outdated docs, e.g. sponsors. Should we remove these too ?
I'm thinking especially about: Wiki, Sponsors and Twisted Matrix Laboratories categories.
(at first I opened this PR because I found a bit weird that the main site was linking to trac wiki archives for these pages)

@adiroiban
Copy link
Member

(at first I opened this PR because I found a bit weird that the main site was linking to trac wiki archives for these pages)

the twisted.org website was created during the transition period.
It was created while the trac wiki was still up and running... as placeholder content.

For the long term, I think that website should be updated to only link to itself or to documentation pages.

We should no longer link to the wiki archives.

The links to the wiki archive are for the transition.


I would say that this PR should be closed and not merged.

We still want to have a sponsors page, but I think that we want that sponsor page on the main website.

But first, we need to find sponsors, and before that we need to find an organization that we can use to collect the money from our sponsors.


and @glyph maybe we can relax the sponsorship criteria, and also consider sponsors the companies that are sponsoring development time or other resources

@glyph
Copy link
Member

glyph commented Oct 15, 2022

and @glyph maybe we can relax the sponsorship criteria, and also consider sponsors the companies that are sponsoring development time or other resources

I'm open to this but it will require participation from the SFC, or migration to a different fiscal sponsor (ideally the PSF)

@adiroiban
Copy link
Member

I have checked the PSF website and Wikipedia page but it doesn't look like PSF offers the same service as SFC.

Regarding SFC, or requests with SFC are not answered in ears.

@JudgeGregg JudgeGregg closed this Oct 16, 2022
@glyph
Copy link
Member

glyph commented Oct 17, 2022

I have checked the PSF website and Wikipedia page but it doesn't look like PSF offers the same service as SFC.

Here's the relevant page: https://www.python.org/psf/fiscal-sponsorees/

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 sponsors doc pages to RST/RTD
4 participants