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

Update contributing docs with current practice #551

Merged
merged 5 commits into from
Jan 30, 2024
Merged

Conversation

rmartin16
Copy link
Member

@rmartin16 rmartin16 commented Jan 27, 2024

Changes

  • Update contributing docs for current practice (mostly the dev process)
  • Reflow (english) docs for 80 character width

PR Checklist:

  • All new features have been tested
  • All new features have been documented
  • I have read the CONTRIBUTING.md file
  • I will abide by the code of conduct

@rmartin16
Copy link
Member Author

rmartin16 commented Jan 27, 2024

The primary goal of this PR was to update https://beeware.org/contributing/how/process/ so I can reference it in the implementation of beeware/.github#63.

I also went through the rest of the pages under contributing to make sure they weren't especially out of date; other than reflowing the text, I updated some punctuation, updated redirected links, and removed references to Travis and BeeKeeper.

@rmartin16 rmartin16 marked this pull request as ready for review January 27, 2024 23:25
@rmartin16 rmartin16 added the preview Approved for an automated preview label Jan 27, 2024
Copy link

github-actions bot commented Jan 27, 2024

Visit the preview URL for this PR (updated for commit 51899e0):

https://beeware-org--pr551-contrib-8m8xy9bb.web.app

(expires Tue, 06 Feb 2024 00:59:11 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: b0da44bc067e7d9a4255c77cb2c5fce572218cec

Copy link
Member

@freakboy3742 freakboy3742 left a comment

Choose a reason for hiding this comment

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

On the whole, these all look like good (and badly needed) changes. I initially started with a pure review, but some of the changes needed to be a bit more substantive, so I've pushed some updates:

  • Removed all references to DCOs. We're not using or enforcing them, and I'm not convinced they're actually needed.
  • Replaced the references to virtualenv with venv
  • Expanded the section on change notes to provide a practical example
  • Added a section on translating the tutorial.

Marking as approved from my perspective; if you spot any typos or inconsistencies in what I've pushed, let me know. Otherwise, I'm happy to have this land as is.

@freakboy3742 freakboy3742 added preview Approved for an automated preview and removed preview Approved for an automated preview labels Jan 29, 2024
@rmartin16 rmartin16 added preview Approved for an automated preview and removed preview Approved for an automated preview labels Jan 29, 2024
Comment on lines -19 to -20
---
_template: translations.html
Copy link
Member Author

Choose a reason for hiding this comment

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

I restored the translations template because the wording above says "select a language below" but this template is necessary to have that list.

That said, the ordering of the page is a little wonky now since this language listing appears after the section about translating the tutorial.

I don't think this is too bad....but I don't know how to make it appear any better in this system. Sooo, I think I'll toss it back to you to address this further or merge as is.

@rmartin16 rmartin16 added preview Approved for an automated preview and removed preview Approved for an automated preview labels Jan 29, 2024
@@ -1,5 +1,7 @@
_model: page
---
_template: translations.html
---
Copy link
Member

Choose a reason for hiding this comment

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

This removal was actually deliberate - the translations template only serves to add the list of translated languages to the body of the text. In the previous version, the body ended with a "We have translations for:" line, which flowed into this extra content; but with the new body content, it makes less sense.

I've removed the template from the translated versions of this page as well; so - we either need to restore it to all versions, or delete it everywhere and delete the template entirely.

Copy link
Member Author

Choose a reason for hiding this comment

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

I see. Are these translations discoverable at all without those links from the translations template?

I updated the wording....but it's just a strange instruction to "find the page in the language" you want to update...

Copy link
Member Author

Choose a reason for hiding this comment

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

ahh...there's a globe next to the Edit button.

Copy link
Member

Choose a reason for hiding this comment

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

Yes - there's a pulldown at the top of the page (the globe icon) that lets you select one of the existing translations.

Copy link
Member Author

@rmartin16 rmartin16 Jan 30, 2024

Choose a reason for hiding this comment

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

Ok; Updated the instructions to use the globe to choose a language prior to clicking edit.

@rmartin16 rmartin16 added preview Approved for an automated preview and removed preview Approved for an automated preview labels Jan 30, 2024
Copy link
Member

@freakboy3742 freakboy3742 left a comment

Choose a reason for hiding this comment

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

Looks good to me! Thanks for prodding this forward!

@freakboy3742 freakboy3742 merged commit 3f9705c into lektor Jan 30, 2024
2 checks passed
@freakboy3742 freakboy3742 deleted the contrib branch January 30, 2024 04:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
preview Approved for an automated preview
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants