Skip to content

docs: organize readme #124

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
Merged
merged 6 commits into from
Oct 21, 2021
Merged

docs: organize readme #124

merged 6 commits into from
Oct 21, 2021

Conversation

grimmerk
Copy link
Contributor

@grimmerk grimmerk commented Oct 18, 2021 •
edited
Loading

@josix josix self-requested a review October 18, 2021 15:01
@grimmerk grimmerk changed the title docs: add more detailed introduction to readme docs: organize readme Oct 21, 2021
@grimmerk
Copy link
Contributor Author

@josix I've added one more commit. BTW, I mention that "make merge" is periodically executed by GitHub actions. Not sure if this is correct or not. @mattwang44, please correct if I'm wrong.

@grimmerk grimmerk force-pushed the organize_readme branch 3 times, most recently from 31ccd37 to 5271e8d Compare October 21, 2021 05:07
@mattwang44
Copy link
Collaborator

mattwang44 commented Oct 21, 2021 •
edited
Loading

"make merge" is periodically executed by GitHub actions

@grimmer0125 Yes, it's correct. We have a workflow currently runs the command once a day and send a draft PR (like this one) if there is any modification in CPython Doc. Thanks for mentioning this in the README!

mattwang44
mattwang44 reviewed Oct 21, 2021
View reviewed changes
README.rst

poedit glossary.po

3. 存檔以後，可以輸出文件以確保你的修改沒有 rST 的語法錯誤或警告 ::
3. 存檔以後，執行以下列指令編譯輸出文件，以確保你的修改沒有 rST 的語法錯誤或警告 ::
Copy link
Collaborator

@mattwang44 mattwang44 Oct 21, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Just found out something worth mentioned here (I can open another PR for this so don't worry 😺):

Actually the Makefile expected the translators to do the translation on 3.X branch here and make command would fail if run on a branch that CPython does not have a corresponding one. I did a hack allowing users to run make command on any branch when I implementing GitHub Action (but forgot to mention it in README).

VERSION=3.9 make

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, I failed to run make merge and I can add this note later (or anyone else adds it).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can add this note later (or anyone else adds it).
I think that I may write an incorrect note about this. @mattwang44 could you supply the relevant note (commit) about this?

Copy link
Collaborator

@mattwang44 mattwang44 Oct 21, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

@grimmer0125 Let's cope with this issue in another PR. This PR is good enough to be merged!

@mattwang44
Copy link
Collaborator

Added a commit 1200b89 for fixing wrong Telegram invitation link.

josix
josix requested changes Oct 21, 2021
View reviewed changes
@grimmerk @josix
Update README.rst
da179b8 
Co-authored-by: Josix <wilson8507@gmail.com>
josix
josix approved these changes Oct 21, 2021
View reviewed changes
Copy link
Collaborator

@josix josix left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM, Thanks @grimmer0125! This update make the translation workflow more clear a lot.

mattwang44
mattwang44 approved these changes Oct 21, 2021
View reviewed changes
Copy link
Collaborator

@mattwang44 mattwang44 left a comment

Choose a reason for hiding this comment

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

LGTM

@josix josix merged commit 52104be into python:3.9 Oct 21, 2021
beccalzh pushed a commit to beccalzh/python-docs-zh-tw that referenced this pull request Sep 4, 2024
@josix
Merge pull request python#124 from grimmer0125/organize_readme
65ec72a 
docs: organize readme
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@josix josix josix approved these changes

@mattwang44 mattwang44 mattwang44 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@grimmerk @mattwang44 @josix