Discussion:
Review of new English templates for Horizon (ie: OpenStack dashboard)
Thomas Goirand
2017-11-14 17:13:06 UTC
Permalink
Hi,

I've added the attached new template to Horizon. Please let me know if
you see issues in it and send us the corrections.

Cheers,

Thomas Goirand (zigo)
Justin B Rye
2017-11-14 17:47:35 UTC
Permalink
Post by Thomas Goirand
I've added the attached new template to Horizon. Please let me know if
you see issues in it and send us the corrections.
A couple of minor ones - revised version and diff attached.
Post by Thomas Goirand
Template: horizon/allowed-hosts
Type: string
_Description: List of allowed hostnames
Enter the list of hostname that can be used to reach your OpenStack Dashboard
^
Post by Thomas Goirand
server. This is a security measure to prevent HTTP Host header attacks, which
are possible even under many seemingly-safe web server configurations.
Oh, yes, there's a trivial English error there: if the hostname was
singular it wouldn't make much of a list. While I'm fixing that we
might as well make it a bit less blunt:

Please enter the list of hostnames that can be used [...]

(Or is this commonly going to be a single permitted hostname? If so
then perhaps it should say "_Description: Allowed hostname(s)", but
I'll assume not.)
Post by Thomas Goirand
.
Enter values separated by comas. Any space will be removed, so you can add
some to make it more readable.
Spelling: "commas". Perhaps a bit wordy, but not worth messing with.
Post by Thomas Goirand
.
Values in this list can be fully qualified names like www.example.com, in
^ ^
That should probably be in quotes, since later you use quotes to
distinguish valid strings from the hostnames they refer to. We've tended
to standardise on double- rather than single-quotes, though.
Post by Thomas Goirand
which case they will be matched against the request's Host header exactly
(case-insensitive, not including port). A value beginning with a period can be
used as a subdomain wildcard: '.example.com' will match example.com,
www.example.com, and any other subdomain of example.com. A value of '*' will
match anything; in this case you are responsible to provide your own
for providing your own
Post by Thomas Goirand
validation of the Host header (perhaps in a middleware; if so this middleware
must be listed first in MIDDLEWARE).
English -ware words are never count nouns, so it's "in middleware" or
"in a middleware layer".
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
Thomas Goirand
2017-11-14 23:05:07 UTC
Permalink
Post by Justin B Rye
Post by Thomas Goirand
I've added the attached new template to Horizon. Please let me know if
you see issues in it and send us the corrections.
A couple of minor ones - revised version and diff attached.
Post by Thomas Goirand
Template: horizon/allowed-hosts
Type: string
_Description: List of allowed hostnames
Enter the list of hostname that can be used to reach your OpenStack Dashboard
^
Post by Thomas Goirand
server. This is a security measure to prevent HTTP Host header attacks, which
are possible even under many seemingly-safe web server configurations.
Oh, yes, there's a trivial English error there: if the hostname was
singular it wouldn't make much of a list. While I'm fixing that we
Please enter the list of hostnames that can be used [...]
(Or is this commonly going to be a single permitted hostname? If so
then perhaps it should say "_Description: Allowed hostname(s)", but
I'll assume not.)
Post by Thomas Goirand
.
Enter values separated by comas. Any space will be removed, so you can add
some to make it more readable.
Spelling: "commas". Perhaps a bit wordy, but not worth messing with.
Post by Thomas Goirand
.
Values in this list can be fully qualified names like www.example.com, in
^ ^
That should probably be in quotes, since later you use quotes to
distinguish valid strings from the hostnames they refer to. We've tended
to standardise on double- rather than single-quotes, though.
Post by Thomas Goirand
which case they will be matched against the request's Host header exactly
(case-insensitive, not including port). A value beginning with a period can be
used as a subdomain wildcard: '.example.com' will match example.com,
www.example.com, and any other subdomain of example.com. A value of '*' will
match anything; in this case you are responsible to provide your own
for providing your own
Post by Thomas Goirand
validation of the Host header (perhaps in a middleware; if so this middleware
must be listed first in MIDDLEWARE).
English -ware words are never count nouns, so it's "in middleware" or
"in a middleware layer".
Thanks Justin,

As always, you produce awesome work on the English of templates. FYI,
some of the text above were simply copied from upstream Django's doc.
I'm not surprised that you still have improvements to contribute! :)

Diff applied and pushed to git, will upload soon, and call for translations.

Cheers,

Thomas Goirand (zigo)

Loading...