Skip to content
This repository has been archived by the owner on Dec 31, 2023. It is now read-only.

Changes to make docs ready for 21.3 launch #11

Merged
merged 102 commits into from
Mar 21, 2021
Merged

Changes to make docs ready for 21.3 launch #11

merged 102 commits into from
Mar 21, 2021

Conversation

ahopkins
Copy link
Member

@ahopkins ahopkins commented Mar 1, 2021

This adds the documentation needed to get the docs ready for the 21.3 launch. I anticipate some more commits once the last few PRs are approved and merged into the core repository.

@ZinkLu and @miss85246, can you guys add commits to this PR with translations?

Also includes:

@ahopkins ahopkins requested review from ZinkLu and miss85246 March 1, 2021 10:15
@ahopkins
Copy link
Member Author

ahopkins commented Mar 1, 2021

defaultTitle: {
  "/": "NEW",
  "/zh/": "新的",
},

☝️ Is this correct?

Copy link
Member

@ZinkLu ZinkLu left a comment

Choose a reason for hiding this comment

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

Yes! NEW == 新的

@ahopkins
Copy link
Member Author

ahopkins commented Mar 1, 2021

I sometimes doubt Google Translate. Glad to know that it worked in this simple context.

Copy link
Member

@ZinkLu ZinkLu left a comment

Choose a reason for hiding this comment

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

Yes! NEW == 新的; Have tried locally, the config works fine in chinese parts.

@ahopkins ahopkins mentioned this pull request Mar 1, 2021
@ahopkins
Copy link
Member Author

ahopkins commented Mar 1, 2021

Yes! NEW == 新的; Have tried locally, the config works fine in chinese parts.

There are a few places where we override the default. I would be curious to know if Chinese is also supported here.

@ahopkins
Copy link
Member Author

ahopkins commented Mar 1, 2021

@ZinkLu and @miss85246 , I just added two documents that are more "organizational" than documentation. One covers various policies for Sanic, the other is the SCOPE (the document that describes how Sanic Community Org funcitons). I am not sure you want to go about translating those, especially the SCOPE. It is a long document, and really not too relevant for what you are doing. I imagine there will also be some changes to it before the end of the year, so I would hate for you to spend too much time treanslating that.

@miss85246
Copy link
Contributor

It seems that a lot of files have been modified. I will take time to compare and modify the translation. Recently, I was busy. The company asked me to use golang to complete the HIDS program, and I felt a little hard.
The progress of translation may be much slower than before. 😢

@ZinkLu
Copy link
Member

ZinkLu commented Mar 2, 2021

It seems that a lot of files have been modified. I will take time to compare and modify the translation. Recently, I was busy. The company asked me to use golang to complete the HIDS program, and I felt a little hard.
The progress of translation may be much slower than before. 😢

NP, I'll handle these new content.
BTW, golang is very esay to learn and easy to use. you can talk to me if you have any issue.

@ZinkLu
Copy link
Member

ZinkLu commented Mar 2, 2021

@ahopkins I think we should try to translate these "organizational" content, It seems very important to the community.

@miss85246
Copy link
Contributor

NP, I'll handle these new content.
BTW, golang is very esay to learn and easy to use. you can talk to me if you have any issue.

Indeed. Golang is not very difficult, but it is very unaccustomed to it, it is less efficient, the leadership urged the tight, and it is done independently, so I feel a little embarrassed

@ahopkins
Copy link
Member Author

ahopkins commented Mar 2, 2021

@ahopkins I think we should try to translate these "organizational" content, It seems very important to the community.

I don't disagree. Just meant that I think they are less important right now. Their utility is more for people wishing to be more deeply involved in the community and not just someone who wants to know how to use Sanic.

There are a few new pages and some additions on a few pages with "new" stuff. The majority of the files have only changed their location. The PR is smaller than it would appear by looking at the file list.

@ZinkLu
Copy link
Member

ZinkLu commented Mar 2, 2021

There are a few new pages and some additions on a few pages with "new" stuff. The majority of the files have only changed their location. The PR is smaller than it would appear by looking at the file list.

Sure, we'll foucus on main content, our target is make all content translated by the date 21.3 released.I shall try to translate community announcement if time permitting.

I wonder whether all new content is on translation branch now? maybe another merge from lanuch should be done?

@ahopkins
Copy link
Member Author

ahopkins commented Mar 2, 2021

I don't want to merge the launch branch until we release. Make commits directly on that branch with translations. It should have all the pages.

@ZinkLu
Copy link
Member

ZinkLu commented Mar 2, 2021

NP

@miss85246 miss85246 requested a review from ZinkLu March 2, 2021 13:41
@miss85246
Copy link
Contributor

I agree to translate "organizational" doc. Infact, I also hope a lot of people interested of sanic. For those who are interested, this document will be a good guide for participating.

@ahopkins
Copy link
Member Author

@ahopkins @ZinkLu
Hey, guys, a good news, we have checked all the documents except running.md, which has not been translated.
All documents will be displayed in a uniform format.
The rest of the questions are use the same proper nouns.
Looking forward to the document release star_struckstar_struckstar_struck

I think there are some changes from this commit missing: 588aef4

@ZinkLu
Copy link
Member

ZinkLu commented Mar 18, 2021

Busy week, will do tonight.

@ahopkins
Copy link
Member Author

Busy week, will do tonight.

Not criticizing, just a reminder.

I think this is the last of the changes. Unless there is something SUPER important missing, I do not think I will have any more changes today.

@miss85246
Copy link
Contributor

miss85246 commented Mar 19, 2021

@ahopkins @ZinkLu work down, is there anything left out? Think again carefully, we need a perfect release conference!🎉🎉🎉

Add missing untranslated  vuepress block titles  in `proxy-headers.md`
@ahopkins
Copy link
Member Author

👏👏👏 Job well done. If only I could read it 😆

@ZinkLu
Copy link
Member

ZinkLu commented Mar 19, 2021

🤔 I am pretty sure there are some contents has not been translated yet. A full review should be done.

1. add block title for `advanced/streaming.md` ==> `en`|`zh`
2. fixed `basic/request.md` error return example ==>  `en`|`zh`
3. modify running parameter display mode, from unordered list to table  ==> `en`|`zh`
4. supplement the missing translation content for `basic/app.md` ==> `zh`
5. supplement the missing translation content for `basic/headers.md` ==> `zh`
6. reformat `basics/middleware.md` ==> `zh`
7. supplement the missing translation content for `basics/request.md` ==> `zh`
8. fixed `best-practices/blueprints.md` error translate content ==> `zh`
9. add new translation file `src/zh/guide/how-to/tls.md` ==> `zh`
1. add block title for `advanced/streaming.md` ==> `en`|`zh`
2. fixed `basic/request.md` error return example ==>  `en`|`zh`
3. modify running parameter display mode, from unordered list to table  ==> `en`|`zh`
4. supplement the missing translation content for `basic/app.md` ==> `zh`
5. supplement the missing translation content for `basic/headers.md` ==> `zh`
6. reformat `basics/middleware.md` ==> `zh`
7. supplement the missing translation content for `basics/request.md` ==> `zh`
8. fixed `best-practices/blueprints.md` error translate content ==> `zh`
9. add new translation file `src/zh/guide/how-to/tls.md` ==> `zh`
@miss85246
Copy link
Contributor

This time, I run the program and found out all untranslated content against en. See here for details

@miss85246
Copy link
Contributor

@ZinkLu Connection should be translated as 连接 or 链接 ? I think it should be 连接, and link corresponds to 链接

@ZinkLu
Copy link
Member

ZinkLu commented Mar 20, 2021

@ZinkLu Connection should be translated as 连接 or 链接 ? I think it should be 连接, and link corresponds to 链接

Ok, feel free to make a change and have another review if you are available.

Copy link
Member

@ZinkLu ZinkLu left a comment

Choose a reason for hiding this comment

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

looks all good to me.

@ahopkins ahopkins marked this pull request as ready for review March 21, 2021 08:27
@ahopkins ahopkins merged commit 567080e into master Mar 21, 2021
@ahopkins ahopkins deleted the launch branch March 21, 2021 08:44
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants