Improve English grammar and consistency #3614

bugreport0 · 2018-03-02T20:25:46Z

See #3512 and some others. I've poured hours and hours into trying to hammer the English translation into something better. Fixed a lot of grammar issues, improved consistency and tried to reword everything to make more sense.

I'm far from finished here, but I wanted to share the first results for discussion. Fire away.

thehowl

Got up to the repo section for now, here's what I got for the first half.

thehowl · 2018-03-02T20:28:50Z

options/locale/locale_en-US.ini

-requite_db_desc = Gitea requires MySQL, MSSQL, PostgreSQL, SQLite3, or TiDB.
+title = Initial Configuration
+docker_helper = If you run Gitea inside Docker, please read the <a target="_blank" rel="noopener" href="%s">documentation</a> before changing any settings.
+requite_db_desc = Gitea requires MySQL, PostgreSQL, MSSQL, SQLite3 or TiDB.


Why are you inverting the order?

That's the actual order of the options in the list.

Fair enough.

@thehowl can you close or accept this if you agree to keep the review page as clean as possible? Thanks!

github won't let me close the conversation in itself, even after approving the pr, so can't do anything about that, sorry :s

thehowl · 2018-03-02T20:34:49Z

options/locale/locale_en-US.ini

+
+general_title = General Settings
+app_name = Site Title
+app_name_helper = Enter your group name here.


... uhmmm, no, I'd rather actually stick to organization here. Here it actually means the company that is hosting the gitea instance, so it makes sense to use organization.

Thanks for the catch! It's an overzealous search-and-replace. Agree this should be 'organization' or 'company' or something. Maybe not 'organization' to prevent cognitive overlap with what we now call a 'group'.

thehowl · 2018-03-02T20:36:02Z

options/locale/locale_en-US.ini

+repo_path_helper = Remote Git repositories will be saved to this directory.
+lfs_path = Git LFS Root Path
+lfs_path_helper = Files tracked by Git LFS will be stored in this directory. Leave empty to disable.
+run_user = Run As Username


This is confusing, because in unix this is actually referred to as the user (or $USER). So I'd stick to user instead of username.

The problem is that someone can't enter a 'user', only the 'name of the user['s] account'. A UNIX user is not its name and vice versa. This one is very tricky to word.

Maybe the following statements in 'legalese' clear up the confusion:

a Unix system is used by a user (a physical person)

on the system, the user has a user account (a tuple in /etc/passwd)

the user account has a username (a string) among other properties

On Gitea installation screen, we want people to enter the username (a string) of the user account (a tuple in /etc/passwd) of the user (a physical person).

Asking for someone to enter the user (a physical person) into an HTML text field removes two layers of indirection and seems physically impossible to me.

if there are some guidelines on language this concept should be documented there.

thehowl · 2018-03-02T20:39:30Z

options/locale/locale_en-US.ini

-admin_title = Admin Account Settings
+require_sign_in_view = Require Sign-In to View Pages
+require_sign_in_view_popup = Limit page access to signed-in users. Visitors will only see the 'sign in' and registration pages.
+admin_setting_desc = Creating an administrator account is optional. The first registered user will automatically become an administrator.


Emphasis on 'now' I think is important. Perhaps 'here' or 'on this page'?

I think this wording is entirely self-contained. It now also fits in one line.

@thehowl can you close or accept this if you agree to keep the review page as clean as possible? Thanks!

thehowl · 2018-03-02T20:48:35Z

options/locale/locale_en-US.ini


 manage_ssh_keys = Manage SSH Keys
 manage_gpg_keys = Manage GPG Keys
 add_key = Add Key
-ssh_desc = These are the SSH keys associated with your account. Because these keys allow anyone using them to gain access to your repositories, it is very important you make sure you recognize them.
-gpg_desc = These are the GPG keys associated with your account. Because these keys allow commits to be verified, it is very important that you keep the corresponding private key safe.
+ssh_desc = These SSH keys are associated with your account. Make sure you recognize all of them as they allow full access to your repositories.


public is also needed here then ;)

Can you elaborate? I don't fully understand this 'public' comment.

See line 377. It adds public to indicate public GPG keys.

I added public to the GPG key text, since it explicitly mentioned the private keys. For consistency, I've added the public/private distinction to the SSH key text as well. Will update my branch later this week.

thehowl · 2018-03-02T20:53:38Z

also, the test fails, which means there's a hardcoded value in the tests somewhere (you can see that in the build log, should be editor_test.go:55, editor_test.go:76, editor_test.go:89)

bugreport0 · 2018-03-02T21:25:45Z

Let's look at tests and LGTMs when everyone is happy. This PR is a work-in-progress. Questions, comments and discussion are important and welcomed. I tried to plot a general new course for the translation and everyone can suggest improvements.

Also @thehowl : reviewing top-to-bottom is great. During translation I'm randomly jumping through all of the file. I just click all the buttons in Gitea and fix the strings wherever they might be in the source file. So it's hard to tell exactly where I 'am' with the translation.

funkyfuture · 2018-03-05T20:32:55Z

options/locale/locale_en-US.ini

-http_port_helper = Port number which application will listen on.
-app_url = Application URL
-app_url_helper = This affects HTTP/HTTPS clone URL and some email notifications.
+http_port_helper = Port number that the Gitea web interface will listen on.


i propose to amend: "… in its execution context (e.g. a container)." to clarify that gitea this is the prt that gitea actually exposes in contrast to a value that is used to assemble strings like a resource url.

@funkyfuture I think the new phrasing is pretty self-contained. …will listen on doesn't leave much room for interpretation? I could lead with TCP/IP port number to make it sound even more physical. I'm pretty sure there's no doubt that Gitea will actually bind and listen on a port on the system you are running it on. Do any others have a strong opinion on this?

I'm pretty sure there's no doubt that Gitea will actually bind and listen on a port on the system you are running it on.

for my sake it's essential to not get the impression that the reachable port is meant for the third time. ;-) my wrong impression obviously stemmed from the fact that other fields surrounding this one are rather 'virtual' (and reachable by the user) than 'physical'. that's worth to explicit in the clearest possible manner without assuming a likely interpretation.

and there's no helpful log message when entering a wrong value here…

Will push an updated branch soon. I've tried to make these fields even less ambiguous. I can see where you're coming from.

funkyfuture · 2018-03-05T20:35:56Z

options/locale/locale_en-US.ini

 admin_name = Username
 admin_password = Password
 confirm_password = Confirm Password
-admin_email = Admin Email
+admin_email = Administrator Email Address


i'd drop the "Administrator" here as you already specified the context in admin_title and admin_name doesn't contain it either.

@funkyfuture how about using Administrator Username and then Email Address? That would solve the visual imbalance between label lengths, while still emphasizing the fact that this is an administrator account. I'm all for removing repetition, but I think this account should be emphasized a little bit.

there's a heading above and an introductary sentence that make the scope very clear. no need for further emphasis, imo - i actually felt very annoyed by the redundance at this point. your proposal is actually imbalancing the width. if you're keen on that 'Confirm' should suffice.

I'm all for at least mentioning 'Administrator' once in the bold labels. It's hard to label and describe options in a foolproof way. I want to accommodate at least a minimum level of reading incomprehension. Will update my branch in a moment so you can see the change; it looks robust.

techknowlogick · 2018-03-08T00:36:18Z

options/locale/locale_en-US.ini

 passcode = Passcode

 repository = Repository
-organization = Organization
+organization = Group


This PR changes org to group, this has implications because we refer to orgs as orgs throughout the application (incl. in the API). If this goes through as is then we would have teams be a part of groups, but to me that doesn't convey a hierarchy.

Could you change all the references to group, back to org?

I agree with @techknowlogick, name Organization shouldn't be changed.

@techknowlogick I think you missed parts of the diff. The hierarchy is expressed as 'group' and 'subgroup'. Hierarchies don't get any clearer than that in English.

@lunny : the main reason @techknowlogick didn't like it ('no implied hierarchy') is actually debunked. Do you have any other reasons to want to keep Organization?

Ten days ago I motivated this change in #3512, but got no replies except for a positive from @thehowl. Unless my statements there are incorrect I see no reason to switch back to Organization and Team, which are (in my opinion) unclear and unfit for Gitea's small-scale, self-hosted use case.

@bugreport0 The main reason I mentioned for my hesitance with this change is that "organization" is used as a reference in code, as well as in API paths. Using org/team language aligns with GitHub as well (especially as we are trying to have an API that aligns with theirs).

Looking at the ticket you referenced, @thehowl makes references to how GitLab does it, however as mentioned we are trying to align with GitHub.

There are many different use cases for Gitea, it sounds like in yours it is small scale, however there are users who use Gitea to support multiple different orgs, and a large number of users.

I also do like group better than org but that is quite big change and should be probably done in either other PR or issue so that it does not block other changes here

@lafriks OK, let's try it that way I'll be updating my PR in a jiffy.

bugreport0 · 2018-03-11T16:04:10Z

Updated my PR. The team/organization change is temporarily undone.

There's some dumb work to do in the bottom-most section of the file where all installation and configuration strings are (needlessly?) duplicated from the beginning of the file. Not looking forward to copying and pasting all that stuff. If anyone has ideas for that, let me know.

lafriks · 2018-03-11T17:18:00Z

options/locale/locale_en-US.ini


 repos.repo_manage_panel = Repository Management
 repos.owner = Owner
 repos.name = Name
-repos.private = Private


I think this should be left as private

I wanted to remove a layer of cognitive indirection ('Private' means 'Hides Repository'), but it's your call. I'll update my PR in a few minutes.

@lafriks : can you update your review status? I think I've correctly reverted to 'private' in my PR.

bugreport0 · 2018-03-15T18:13:42Z

Alright, I wrapped up the entire file with the site administration section. @lafriks I reverted to the 'private' repository visibility string. If everyone can do another review, I'll get onto fixing the tests once we're happy.

lafriks · 2018-03-20T21:45:42Z

options/locale/locale_en-US.ini

+lfs_path = Git LFS Root Path
+lfs_path_helper = Files tracked by Git LFS will be stored in this directory. Leave empty to disable.
+run_user = Run As Username
+run_user_helper = Enter the operating system username that runs Gitea. Note that this user must have access to the repository root path.


This sound a bit weird. Wouln't it be better ... that Gitea runs under...?

Sounds decent, I'll update.

Looking at the header for this option, I went with …that Gitea runs as… which makes even more sense.

lafriks

Apart from comments below looks very nice 👍

lafriks · 2018-03-20T21:47:09Z

options/locale/locale_en-US.ini

+lfs_path_helper = Files tracked by Git LFS will be stored in this directory. Leave empty to disable.
+run_user = Run As Username
+run_user_helper = Enter the operating system username that runs Gitea. Note that this user must have access to the repository root path.
+domain = Server SSH Domain


This should probably be better as SSH Server Domain

I wanted to emphasize that this is related to the actual server (as a whole), instead of any built-in SSH server functionality. I'll switch it around for now.

lafriks · 2018-03-20T21:47:19Z

options/locale/locale_en-US.ini

+run_user_helper = Enter the operating system username that runs Gitea. Note that this user must have access to the repository root path.
+domain = Server SSH Domain
+domain_helper = Domain or host address for SSH clone URLs.
+ssh_port = Server SSH Port


lafriks · 2018-03-20T21:52:02Z

options/locale/locale_en-US.ini

-alpha_dash_error = ` must be valid alphanumeric or dash(-_) characters.`
-alpha_dash_dot_error = ` must be valid alphanumeric, dash(-_) or dot characters.`
-git_ref_name_error = ` must be a well formed git reference name.`
+alpha_dash_error = ` should contain only alphanumeric, dash ('-') and underscore ('_') characters.`


this one should have or like one below or next one should be changed to and so that both have same

Good catch! I changed the second one into and, since it's an inclusive enumeration.

lafriks · 2018-03-20T21:57:21Z

options/locale/locale_en-US.ini

-branch.deletion_failed = Failed to delete branch %s.
-branch.delete_branch_has_new_commits = %s cannot be deleted because new commits have been added after merging.
+branch.delete_desc = Deleting a branch is permanent. It <strong>CANNOT</strong> be undone. Continue?
+branch.delete_notices_1 = 


These lines should be probably removed here and also from template files if not needed anymore

I'll see what I can do. I don't want to shuffle around too much stuff, but I understand that you don't want empty strings lying around.

I've removed four references to branch.delete_notices_* strings, I think that's all.

techknowlogick

Updating my "request changes" to just a comment to no longer block this request.

techknowlogick

Updating my "request changes" to just a comment to no longer block this request.

thehowl · 2018-03-23T05:45:58Z

just to be clear; @thehowI is a copycat, not actually me.

bugreport0 · 2018-03-29T13:49:54Z

@lafriks @lunny @appleboy Just updated my PR with the latest review by @lafriks but now the build is failing for some kind of obscure reason. Can someone help me out? I don't think my changes are to blame here.

bugreport0 · 2018-04-17T18:39:54Z

@lafriks @lunny @appleboy : I've just merged and updated my branch/PR again. Do you have an estimated merge schedule for this PR? Other translators might want to start updating their strings for 1.5.0.

lafriks · 2018-04-19T12:18:57Z

Thanks for your work, I think it is ready to merge now

* SECURITY * Limit uploaded avatar image-size to 4096x3072 by default (go-gitea#4353) * Do not allow to reuse TOTP passcode (go-gitea#3878) * FEATURE * Add cli commands to regen hooks & keys (go-gitea#3979) * Add support for FIDO U2F (go-gitea#3971) * Added user language setting (go-gitea#3875) * LDAP Public SSH Keys synchronization (go-gitea#1844) * Add topic support (go-gitea#3711) * Multiple assignees (go-gitea#3705) * Add protected branch whitelists for merging (go-gitea#3689) * Global code search support (go-gitea#3664) * Add label descriptions (go-gitea#3662) * Add issue search via API (go-gitea#3612) * Add repository setting to enable/disable health checks (go-gitea#3607) * Emoji Autocomplete (go-gitea#3433) * Implements generator cli for secrets (go-gitea#3531) * ENHANCEMENT * Add more webhooks support and refactor webhook templates directory (go-gitea#3929) * Add new option to allow only OAuth2/OpenID user registration (go-gitea#3910) * Add option to use paged LDAP search when synchronizing users (go-gitea#3895) * Symlink icons (go-gitea#1416) * Improve release page UI (go-gitea#3693) * Add admin dashboard option to run health checks (go-gitea#3606) * Add branch link in branch list (go-gitea#3576) * Reduce sql query times in retrieveFeeds (go-gitea#3547) * Option to enable or disable swagger endpoints (go-gitea#3502) * Add missing licenses (go-gitea#3497) * Reduce repo indexer disk usage (go-gitea#3452) * Enable caching on assets and avatars (go-gitea#3376) * Add repository search ordered by stars/forks. Forks column in admin repo list (go-gitea#3969) * Add Environment Variables to Docker template (go-gitea#4012) * LFS: make HTTP auth period configurable (go-gitea#4035) * Add config path as an optionial flag when changing pass via CLI (go-gitea#4184) * Refactor User Settings sections (go-gitea#3900) * Allow square brackets in external issue patterns (go-gitea#3408) * Add Attachment API (go-gitea#3478) * Add EnableTimetracking option to app settings (go-gitea#3719) * Add config option to enable or disable log executed SQL (go-gitea#3726) * Shows total tracked time in issue and milestone list (go-gitea#3341) * TRANSLATION * Improve English grammar and consistency (go-gitea#3614) * DEPLOYMENT * Allow Gitea to run as different USER in Docker (go-gitea#3961) * Provide compressed release binaries (go-gitea#3991) * Sign release binaries (go-gitea#4188)

Start improving English grammar and consistency.

94618f7

bugreport0 mentioned this pull request Mar 2, 2018

English translation grammar and consistency #3512

Closed

lafriks added the modifies/translation label Mar 2, 2018

lafriks added this to the 1.5.0 milestone Mar 2, 2018

thehowl suggested changes Mar 2, 2018

View reviewed changes

tboerger added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Mar 2, 2018

bugreport0 mentioned this pull request Mar 5, 2018

Some updates to installation texts #3623

Closed

funkyfuture reviewed Mar 5, 2018

View reviewed changes

bugreport0 added 2 commits March 5, 2018 20:49

Apply review comments, push translation further.

4322fa7

Merge branch 'master' into patch-6

b459740

thehowl approved these changes Mar 6, 2018

View reviewed changes

tboerger added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Mar 6, 2018

bugreport0 added 2 commits March 6, 2018 21:43

Additional review changes; expand translation.

22f651e

Merge branch 'master' into patch-6

6e5e751

techknowlogick requested changes Mar 8, 2018

View reviewed changes

bugreport0 added 2 commits March 11, 2018 16:00

Undo team/organization change, further translation.

6f34061

Merge branch 'master' into patch-6

5365e23

lafriks requested changes Mar 11, 2018

View reviewed changes

bugreport0 added 2 commits March 15, 2018 18:11

Add site administration; review comments; merge.

9c4a89a

Merge branch 'master' into patch-6

53e8eaf

bugreport0 added 4 commits March 18, 2018 20:34

Merge branch 'master' into patch-6

83811aa

Merge branch 'master' into patch-6

2e0850d

Update hardcoded branch protection string tests.

3d69edb

Update hardcoded branch deletion string test.

0d1c394

lafriks reviewed Mar 20, 2018

View reviewed changes

lafriks requested changes Mar 20, 2018

View reviewed changes

appleboy approved these changes Mar 21, 2018

View reviewed changes

tboerger added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Mar 21, 2018

techknowlogick reviewed Mar 21, 2018

View reviewed changes

techknowlogick approved these changes Mar 21, 2018

View reviewed changes

bugreport0 added 5 commits March 29, 2018 13:32

Implement @lafriks review comments.

78405b2

Merge branch 'master' into patch-6

c166d27

Merge branch 'master' into patch-6

d6a6af4

Remove (now) unused branch deletion warnings.

93da6de

Remove (now) unused branch deletion warnings.

368a2cc

lunny and others added 2 commits March 30, 2018 07:22

Merge branch 'master' into patch-6

25cee9d

Merge branch 'master' into patch-6

ee4721c

lafriks approved these changes Apr 19, 2018

View reviewed changes

Merge branch 'master' into patch-6

87d89a1

Merge branch 'master' into patch-6

f20fdf9

appleboy approved these changes Apr 19, 2018

View reviewed changes

lafriks merged commit bac6d05 into go-gitea:master Apr 19, 2018

lafriks changed the title ~~Start improving English grammar and consistency.~~ Improve English grammar and consistency. (#3614) Apr 19, 2018

lafriks changed the title ~~Improve English grammar and consistency. (#3614)~~ Improve English grammar and consistency Apr 19, 2018

lafriks added the type/changelog Adds the changelog for a new Gitea version label Apr 19, 2018

go-gitea locked and limited conversation to collaborators Nov 24, 2020

delvh removed the type/changelog Adds the changelog for a new Gitea version label Oct 7, 2023

Improve English grammar and consistency #3614

Improve English grammar and consistency #3614

Conversation

bugreport0 commented Mar 2, 2018

thehowl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bugreport0 Mar 2, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thehowl commented Mar 2, 2018 • edited Loading

bugreport0 commented Mar 2, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

funkyfuture Mar 5, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bugreport0 Mar 8, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bugreport0 commented Mar 11, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bugreport0 commented Mar 15, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lafriks left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

techknowlogick left a comment

Choose a reason for hiding this comment

techknowlogick left a comment

Choose a reason for hiding this comment

thehowl commented Mar 23, 2018

bugreport0 commented Mar 29, 2018

bugreport0 commented Apr 17, 2018

lafriks commented Apr 19, 2018

bugreport0 Mar 2, 2018 •

edited

Loading

thehowl commented Mar 2, 2018 •

edited

Loading

bugreport0 commented Mar 2, 2018 •

edited

Loading

funkyfuture Mar 5, 2018 •

edited

Loading

bugreport0 Mar 8, 2018 •

edited

Loading

lafriks left a comment •

edited

Loading