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.

Sign up for GitHub

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

Jump to bottom

Update Contribution Guidelines, add FAQ, CONTACT and CONTRIBUTING as separate documents, fix links #8448

Merged
merged 12 commits into from
Nov 23, 2023
Merged

Update Contribution Guidelines, add FAQ, CONTACT and CONTRIBUTING as separate documents, fix links #8448

merged 12 commits into from
Nov 23, 2023

Conversation

Julian-O
Copy link
Contributor

@Julian-O Julian-O commented Nov 11, 2023 •
edited by misl6
Loading

Dear reviewers: Most of the content is moved the the RST documents, with RST-> MD edits, and other light copy-editing. Hopefully, there shouldn't be technical errors in that (apart from obsolete info).

However, there are also sections that are new (or substantially new) that you should check are factually correct as well as style, etc:

  • Supported Python versions (removed Python 2 versus 3 discussion, and rewrote)
  • Relationship with kivy3, kivy4, kivy5, kivyMD
  • Internationalization section

Future work:

  • Add references to contact us.
  • Some of the historical answers (Why Python? Relationship with PyMT) are way too long for an FAQ.

Maintainer merge checklist

  • Title is descriptive/clear for inclusion in release notes.
  • Applied a Component: xxx label.
  • Applied the api-deprecation or api-break label.
  • Applied the release-highlight label to be highlighted in release notes.
  • Added to the milestone version it was merged into.
  • Unittests are included in PR.
  • Properly documented, including versionadded, versionchanged as needed.

@Julian-O
Copy link
Contributor Author

Okay, I didn't actually mean to update the Contribution Guide in the same branch, and hence into the same PR and same review as the FAQ, but... well, it is done now.

misl6
misl6 requested changes Nov 12, 2023
View reviewed changes
Copy link
Member

@misl6 misl6 left a comment

Choose a reason for hiding this comment

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

Hi !

Looks great, however I added a couple of comments which need to be addressed befor e merge.

FAQ.md Outdated Show resolved Hide resolved
doc/sources/contribute.rst Outdated Show resolved Hide resolved
@Julian-O
Copy link
Contributor Author

Thanks for the eagle eyes. Fixes made.

@Julian-O Julian-O changed the title Add FAQ as separate document. Removed from RST docs. Update Contribution Guidelines. Add FAQ as separate document. Removed from RST docs. Nov 16, 2023
This was referenced Nov 16, 2023
Open
Closed
@Julian-O
Copy link
Contributor Author

Now bigger than ever before, with #8450 included.

@Julian-O Julian-O requested a review from misl6 November 19, 2023 12:32
@misl6
Copy link
Member

misl6 commented Nov 19, 2023

@Julian-O we have a conflict 😬, can you take a look?

misl6
misl6 reviewed Nov 19, 2023
View reviewed changes
doc/README.md Outdated Show resolved Hide resolved
@Julian-O
Add FAQ as separate document. Removed from RST docs.
2b14475 
Future work:

* Add references to contact us.
@Julian-O
Substantial Rewrite of Contributing Guidelines
8df4ef6
@Julian-O
Updated with review comments.
69da2ff
@Julian-O
Avoid duplicating contribution instructions
1cd820b 
Reference the contribution guidelines online rather than repeating them.
Make language more consistent with other sources.
@Julian-O
Reshuffle contents based on review comments.
7aa4006 
* Move contributing to root dir, populate it with contents of contribute.rst and contribute-unittest.rst
* Delete contribute.rst and contribute-unittest.rst
* Delete the defunct Google Summers of Code
*Add CONTACT.md, populating it from CONTACT.rst.
* Reference new CONTACT.md from Index.
* Fix broken links, ToC.
* Fix another link.
* Bring in changes to README and setup.py from kivy#8450.
* Include OpenGL reference
* Mention all the sponsors.
@Julian-O
Wrong README file was modified - try again
30da893
@Julian-O
Copy link
Contributor Author

Fixed readme error. Rebased.

misl6
misl6 requested changes Nov 21, 2023
View reviewed changes
Copy link
Member

@misl6 misl6 left a comment

Choose a reason for hiding this comment

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

Hi @Julian-O !

Great job!
I've left some comments, and some of them need to be addressed before merge.

PS: maybe we can add links to CONTACT.md, CONTRIBUTING.md, FAQ.md here?

Image 21-11-23 at 19 09

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
CONTACT.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
FAQ.md Outdated Show resolved Hide resolved
@Julian-O
Copy link
Contributor Author

PS: maybe we can add links to CONTACT.md, CONTRIBUTING.md, FAQ.md here?

I would love to have done that, but could not work out how.

I tried reading up on the ReadTheDocs theme, but couldn't see any parameters. Sphinx isn't my speciality, so open to suggestions

@Julian-O
Updated a bunch of http -> https
917f18e 
Not every single instance, but made a major dent.
Only instances where https worked (inclem.net, I am looking at you.)
@Julian-O
Update CODE_OF_CONDUCT.md to be the most modern version
8267a21
@Julian-O
Update with review comments
903fed8
@Julian-O
Correct link
04ce674
@Julian-O
Copy link
Contributor Author

@misl6 All done. Fingers crossed.

@misl6
Copy link
Member

misl6 commented Nov 22, 2023

PS: maybe we can add links to CONTACT.md, CONTRIBUTING.md, FAQ.md here?

I would love to have done that, but could not work out how.

I tried reading up on the ReadTheDocs theme, but couldn't see any parameters. Sphinx isn't my speciality, so open to suggestions

We likely need to change the template and include some arbitrary links.
But, as explained in #8466 (and I agree), the template is somehow broken.

I'm working on an alternative, based on https://github.com/pradyunsg/furo, the same one we now use on some Kivy's sibling projects, so let's address it later.

But, meanwhile, do you mind re-adding contact.rst and contribute.rst and add the link (like https://github.com/kivy/kivy/blob/04ce6743f4b2fae6de5e6ca4096a5c168b98078c/doc/sources/faq.rst) ?

P.S. Here we still have references to the previously available pages:
https://github.com/Julian-O/kivy/blob/FAQ/doc/sources/user-guide.rst

@mak8kammerer
Copy link
Contributor

Sorry, there were some problems with checking the code. I closed the old reviews and opened the new ones.

@Julian-O
Add stubs for GitHub-hosted pages
02dff83
@Julian-O
Fix links
3b22813 
RST broken by line feed.
Inline link.
@Julian-O Julian-O requested a review from misl6 November 23, 2023 05:59
@Julian-O
Copy link
Contributor Author

7th time is the charm!

misl6
misl6 approved these changes Nov 23, 2023
View reviewed changes
Copy link
Member

@misl6 misl6 left a comment

Choose a reason for hiding this comment

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

🥁 LGTM. Thank you!

@misl6 misl6 changed the title Update Contribution Guidelines. Add FAQ as separate document. Removed from RST docs. Update Contribution Guidelines, add FAQ, CONTACT and CONTRIBUTING as separate documents. Nov 23, 2023
@misl6 misl6 changed the title Update Contribution Guidelines, add FAQ, CONTACT and CONTRIBUTING as separate documents. Update Contribution Guidelines, add FAQ, CONTACT and CONTRIBUTING as separate documents Nov 23, 2023
@misl6 misl6 added the Component: documentation Documentation or examples label Nov 23, 2023
@misl6 misl6 added this to the 2.3.0 milestone Nov 23, 2023
@misl6 misl6 changed the title Update Contribution Guidelines, add FAQ, CONTACT and CONTRIBUTING as separate documents Update Contribution Guidelines, add FAQ, CONTACT and CONTRIBUTING as separate documents, fix links Nov 23, 2023
@misl6 misl6 merged commit 9c8528d into kivy:master Nov 23, 2023
33 of 34 checks passed
@Julian-O Julian-O deleted the FAQ branch December 3, 2023 12:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@misl6 misl6 misl6 approved these changes

@mak8kammerer mak8kammerer mak8kammerer approved these changes

Assignees
No one assigned
Labels
Component: documentation Documentation or examples
Projects
None yet
Milestone
2.3.0
Development

Successfully merging this pull request may close these issues.
3 participants
@Julian-O @misl6 @mak8kammerer