-
Notifications
You must be signed in to change notification settings - Fork 1k
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 virtual environment guide URL on contributing page #2200
Conversation
I am wondering whether it might be also be useful to integrate this link, which directs to the pvlib user guide section on virtual environments, into the same sentence? |
Based on the URL, this seems to be an "unofficial" set of docs that How about something like https://learn.scientific-python.org/development/tutorials/dev-environment/ instead? I haven't compared in depth with the previous page, but in general I'd prefer to link to some kind of central resource like |
No, I would keep the sections separate. Although they are both related to setting up a dev environment for contributing, the 2nd focuses on using conda . I think pvlib needs to have its own help on this that doesn’t depend on a link to another project. There should be links between the two sections tho. |
Ah... when I said integrate the link into the sentence, I meant literally only the link --- not bring over the linked section and merge both sections. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! I'll leave this open for a few days in case any other ideas pop up.
Actually something I have been thinking about is that there is no obvious point of contact on the contributing page in case someone wants to reach out. What is the best point of contact, is it the Google group? Is there an email address? The Google group is linked in the Easy ways to contribute section, which is good, but perhaps referring to that link (or whatever is the best contact option) somewhere more explicitly as a means of getting in touch with the community for advice/questions about contributing to pvlib specifically might be an improvement. Another thought, after reading some of the contributing pages on other projects (through the discussion in #2202), I feel like our contributing page would benefit from being broken up into a few pages. These pages would still all be under the same "Contributing" section, but they could be navigated through using the sidebar (like the user guide?) What do you guys think? These points may be out of scope for this URL update PR (at least the second one is for sure) and may warrant a separate issue for further discussion first. Should I open a new issue for either or both of these points? |
I would prefer that they open an Issue or Discussion rather than send an email. |
Agree fully. |
These points will be resolved separately now (#2210) so, other than those points, if there's anything else required for this PR then just let me know |
Thanks @RDaxini! |
docs/sphinx/source/whatsnew
for all changes. Includes link to the GitHub Issue with:issue:`num`
or this Pull Request with:pull:`num`
. Includes contributor name and/or GitHub username (link with:ghuser:`user`
).remote-data
) and Milestone are assigned to the Pull Request and linked Issue.Original link: https://docs.astropy.org/en/latest/development/workflow/virtual_pythons.html
New link: https://astropy-astrofrog.readthedocs.io/en/latest/development/workflow/virtual_pythons.html
Could someone confirm the new link here is the correct/intended webpage for the guide?