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

Support ReadtheDocs #105

Closed
kelle opened this issue Jun 5, 2020 · 17 comments
Closed

Support ReadtheDocs #105

kelle opened this issue Jun 5, 2020 · 17 comments

Comments

@kelle
Copy link
Member

kelle commented Jun 5, 2020

Based on discussion in #39, there is a concensus that we want to be supporting ReadtheDocs. I'm starting a new thread specifically for that action item.

Since NumFocus takes care of our Slack and Zoom costs, I am in discussions with them to see if we want to communicate with RTD as "Astropy" or as part of a larger contribution from NumFocus which could benefit more projects. I will update as we work this out.

@kelle
Copy link
Member Author

kelle commented Jun 5, 2020

We're gonna move forward with contributing as Astropy. I'll get in touch with RTD directly to figure out the arrangement that makes the most sense for us.

@pllim
Copy link
Member

pllim commented Jun 5, 2020

Please tell them that we really want to use their PR builder feature for astropy. My previous request for that was rejected because astropy is "too big and too active" but hopefully that is not a problem if we are a paying customer? Thanks!

@bsipocz
Copy link
Member

bsipocz commented Jun 5, 2020

there is also a short list of feature we would very much like for a very long time now, let's see maybe they are open to those being "paid for".
(the most important is the disabling the github edit links that redirects to the stable branch. it shouldn't take time much for someone familiar with their JS)

@kelle
Copy link
Member Author

kelle commented Jun 5, 2020 via email

@pllim
Copy link
Member

pllim commented Jun 5, 2020

Can't think of anything else for now. I think the issue that @bsipocz mentioned above is readthedocs/readthedocs.org#6297 (please correct me if I am wrong).

@bsipocz
Copy link
Member

bsipocz commented Jun 5, 2020

Yes, that's the issue. The other one I had in mind seems to be resolved very recently (being able to hide versions from dropdown, while they are still available with direct links).

Another one, that I cannot find an issue for is the ability to disable indexing of old versions (we manually worked around that issue as were not able to add the robots files, but it's not a final, good solution). I suspect adding these custom configs on the project level might be a more significant feature request.

@bsipocz
Copy link
Member

bsipocz commented Jun 5, 2020

(but as @pllim said, the most important would be to be able to trigger builds from PRs)

@Cadair
Copy link
Member

Cadair commented Jun 8, 2020

(As an aside, please do let me know how the discussions with RTD go and what kind of arrangement you end up with to enable PR builds etc, I would be potentially interested in replicating it for sunpy.)

@kelle
Copy link
Member Author

kelle commented Jun 12, 2020

email sent and cc'd @bsipocz and @pllim.

@kelle
Copy link
Member Author

kelle commented Jun 26, 2020

Finance committee approved support at the $600/year level. And Kelle used the PEX card to upgrade the astropy membership.

@kelle kelle closed this as completed Jun 26, 2020
@kelle
Copy link
Member Author

kelle commented Jun 26, 2020

At our level, we can only make 10 projects ad-free. Which of the following 13 should be made ad-free?
Screen Shot 2020-06-26 at 11 41 45 AM

@kelle kelle reopened this Jun 26, 2020
@bsipocz
Copy link
Member

bsipocz commented Jun 26, 2020

core and coordinated packages. Many of which is not on the list, but they should be.

That leaves two more slots, I would go for the template, and pyvo as for the latter the plan was to make it coordinated sometimes late last year.

@astrofrog
Copy link
Member

Agree with @bsipocz that we should do core package + the 7 coordinated packages - we need to add astropy as a maintainer on all coordinated packages for them to all show up.

@kelle
Copy link
Member Author

kelle commented Jul 3, 2020

Do y'all need me to do anything else with this? Not sure who is can add astropy as a maintainer on the coordinated packages. Should we send an email to the maintainer's list with instructions?

@pllim
Copy link
Member

pllim commented Jul 6, 2020

FWIW -- As far as this issue is concerned, I think it can be closed when #105 (comment) is resolved. As for enabling it for those repos, they can be tracked as separate issues for the affected repos.

@kelle
Copy link
Member Author

kelle commented Mar 22, 2022

This is the content of the email response from rtd. (As far as I can tell, we never got back to them about the github edit links.)

Firstly, thanks for your interest in supporting us. We're truly grateful.

  • access to the PR build feature

This feature looks like it's enabled for you already -- at least for your base project. We are slowly enabling this for more and more projects as we roll it out more widely and if there are additional projects that need it, don't hesitate to let us know.

  • disable the github edit links that redirects to the stable branch.

I did have a question about this. I attached a quick screenshot and I just wanted to clarify that these were the links you were trying to remove. Is that correct?

  • disable indexing of old versions

You can control this yourself! Simply choose the versions you want to be "active" on this page. Updating the active versions will automatically update a generated sitemap file and inform search engines which version should be indexed.

Could you please let us know if those requests are feasible and what level of monthly support you think would be appropriate for us?

Our recommended levels of support is $50 for company- or grant-backed projects. If that works, we really appreciate it.

@pllim
Copy link
Member

pllim commented Mar 23, 2022

xref #248

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

No branches or pull requests

5 participants