From 73cf1732eb7cfdc34c22b6eafc094cea2015ede5 Mon Sep 17 00:00:00 2001 From: Maz Ameli <maz@metabase.com> Date: Tue, 31 Mar 2020 10:38:07 -0700 Subject: [PATCH] Update info on languages in README and docs (#12218) * update info on languages * grammar --- README.md | 17 +++--- .../08-configuration-settings.md | 19 +++--- docs/developers-guide.md | 20 +++---- ...hat-languages-can-be-used-with-metabase.md | 59 ++++++++++++------- ...t-languages-is-metabase-compatible-with.md | 24 -------- docs/faq/start.md | 3 +- 6 files changed, 69 insertions(+), 73 deletions(-) delete mode 100644 docs/faq/general/what-languages-is-metabase-compatible-with.md diff --git a/README.md b/README.md index 83adff7d7ae..a38c2026304 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # Metabase + Metabase is the easy, open source way for everyone in your company to ask questions and learn from data.  @@ -9,6 +10,7 @@ Metabase is the easy, open source way for everyone in your company to ask questi [](https://gitter.im/metabase/metabase) # Features + - 5 minute [setup](https://metabase.com/docs/latest/setting-up-metabase.html) (We're not kidding) - Let anyone on your team [ask questions](https://metabase.com/docs/latest/users-guide/04-asking-questions.html) without knowing SQL - Rich beautiful [dashboards](https://metabase.com/docs/latest/users-guide/06-sharing-answers.html) with auto refresh and fullscreen @@ -42,7 +44,7 @@ Don't see your favorite database? File an issue to let us know. ## Installation -Metabase can be run just about anywhere so checkout our [Installation Guides](https://metabase.com/docs/latest/operations-guide/start.html#installing-and-running-metabase) for detailed instructions for various deployments. Here's the TLDR: +Metabase can be run just about anywhere so checkout our [Installation Guides](https://metabase.com/docs/latest/operations-guide/start.html#installing-and-running-metabase) for detailed instructions for various deployments. Here's the TLDR: ### Docker @@ -91,26 +93,23 @@ Some questions come up over and over again. Check here first: Security is very important to us. If you discover any issue regarding security, please disclose the information responsibly by sending an email to security@metabase.com and not by creating a GitHub issue. - # Contributing To get started with a development installation of the Metabase, follow the instructions at our [Developers Guide](docs/developers-guide.md). Then take a look at our [Contribution Guide](docs/contributing.md) for information about our process and where you can fit in! -Talk to other contributors [in our Gitter room](https://gitter.im/metabase/metabase). - # Internationalization -We want Metabase to be available in as many languages as possible. See what translations are available and help contribute to internationalization using our project [over at POEditor](https://poeditor.com/join/project/ynjQmwSsGh) + +We want Metabase to be available in as many languages as possible. See what translations are available and help contribute to internationalization using our project over at [POEditor](https://poeditor.com/join/project/ynjQmwSsGh). You can also check out our [policies on translations](docs/faq/general/what-languages-can-be-used-with-metabase.md). # Extending and Deep Integrations Metabase also allows you to hit our Query API directly from Javascript to integrate the simple analytics we provide with your own application or third party services to do things like: -* Build moderation interfaces -* Export subsets of your users to third party marketing automation software -* Provide a specialized customer lookup application for the people in your company - +- Build moderation interfaces +- Export subsets of your users to third party marketing automation software +- Provide a specialized customer lookup application for the people in your company # Danger zone diff --git a/docs/administration-guide/08-configuration-settings.md b/docs/administration-guide/08-configuration-settings.md index 0f2afa572fe..8975465d5bc 100644 --- a/docs/administration-guide/08-configuration-settings.md +++ b/docs/administration-guide/08-configuration-settings.md @@ -1,32 +1,35 @@ - ## Settings + Here are a few other miscellaneous settings you can configure from the home page of the **Admin Panel**. ### Site Name + How you’d like to refer to this instance of Metabase. ### Site URL + The base URL of this Metabase instance. The base URL is used in emails to allow users to click through to their specific instance. Make sure to include http:// or https:// to make sure it’s reachable. ### Email Address for Help Requests -This email address will be displayed in various messages throughout Metabase when users encounter a scenario where they need assistance from an admin, such as a password reset request. +This email address will be displayed in various messages throughout Metabase when users encounter a scenario where they need assistance from an admin, such as a password reset request. ### Report Timezone -The **report timezone** sets the default time zone for displaying times. The timezone is used when breaking out data by dates. -*Setting the default timezone will not change the timezone of any data in your database*. If the underlying times in your database aren't assigned to a timezone, Metabase will use the report timezone as the default timezone. +The **report timezone** sets the default time zone for displaying times. The timezone is used when breaking out data by dates. +_Setting the default timezone will not change the timezone of any data in your database_. If the underlying times in your database aren't assigned to a timezone, Metabase will use the report timezone as the default timezone. ### Language Settings -Metabase has been translated into a variety of languages, and relies on the user's browser language to determine which language should be used. This setting allows you to configure the language to be used for external Metabase communications, such as emails and pulses. - +Metabase has been translated into a variety of languages, and this setting allows you to configure the language to be used for external Metabase communications, such as emails and pulses. There is not currently a setting to set the language in the Metabase interface for all of your users; instead, Metabase relies on each user's browser language to determine which language should be used, provided Metabase supports that translation. You can check [which languages Metabase currently supports](../faq/general/what-languages-can-be-used-with-metabase.md). ### Anonymous Tracking -This option turns determines whether or not you allow [anonymous data about your usage of Metabase](../information-collection.md) to be sent back to us to help us improve the product. *Your database’s data is never tracked or sent*. + +This option turns determines whether or not you allow [anonymous data about your usage of Metabase](../information-collection.md) to be sent back to us to help us improve the product. _Your database’s data is never tracked or sent_. ### Enable X-rays + [X-rays](../users-guide/14-x-rays.md) are a great way to allow your users to quickly explore your data or interesting parts of charts, or to see a comparison of different things. But if you're dealing with data sources where allowing users to run x-rays on them would incur burdonsome performance or monetary costs, you can turn them off here. ### Enabled Nested Queries @@ -34,6 +37,7 @@ This option turns determines whether or not you allow [anonymous data about your By default, Metabase allows your users to use a previously saved question as a source for queries. If you have a lot of slow running queries, you may want to switch this option off, as performance problem can occur. ### Friendly Table and Field Names + By default, Metabase attempts to make field and table names more readable by changing things like `somehorriblename` to `Some Horrible Name`. This does not work well for languages other than English, or for fields that have lots of abbreviations or codes in them. If you'd like to turn this setting off, you can do so from the Admin Panel under Settings > General > Friendly Table and Field Names. To manually fix field or table names if they still look wrong, you can go to the Metadata section of the Admin Panel, select the database that contains the table or field you want to edit, select the table, and then edit the name(s) in the input boxes that appear. @@ -41,4 +45,5 @@ To manually fix field or table names if they still look wrong, you can go to the --- ## Next: setting formatting defaults for dates and numbers + Easily customize how numbers, dates, times, and currencies should be displayed in Metabase with [formatting settings](19-formatting-settings.md). diff --git a/docs/developers-guide.md b/docs/developers-guide.md index 36bfc1523c3..e855874e9ac 100644 --- a/docs/developers-guide.md +++ b/docs/developers-guide.md @@ -1,10 +1,10 @@ **This guide will teach you:** -* [How to compile your own copy of Metabase](#build-metabase) -* [How to set up a development environment](#development-environment) -* [How to run the Metabase Server](#development-server-quick-start) -* [How to contribute back to the Metabase project](#contributing) -* [How to add support in Metabase for other languages](#internationalization) +- [How to compile your own copy of Metabase](#build-metabase) +- [How to set up a development environment](#development-environment) +- [How to run the Metabase Server](#development-server-quick-start) +- [How to contribute back to the Metabase project](#contributing) +- [How to add support in Metabase for other languages](#internationalization) # Contributing @@ -79,9 +79,9 @@ Start the frontend build process with We use these technologies for our FE build process to allow us to use modules, es6 syntax, and css variables. -* webpack -* babel -* cssnext +- webpack +- babel +- cssnext Frontend tasks are executed using `yarn`. All available tasks can be found in `package.json` under _scripts_. @@ -324,10 +324,10 @@ and in the backend using `trs` and related macros (see more details in https://g ### Translation errors or missing strings -If you see incorrect or missing strings for your langauge, please visit our [POEditor project](https://poeditor.com/join/project/ynjQmwSsGh) and submit your fixes there. +If you see incorrect or missing strings for your language, please visit our [POEditor project](https://poeditor.com/join/project/ynjQmwSsGh) and submit your fixes there. ## License -Copyright © 2017 Metabase, Inc +Copyright © 2020 Metabase, Inc. Distributed under the terms of the GNU Affero General Public License (AGPL) except as otherwise noted. See individual files for details. diff --git a/docs/faq/general/what-languages-can-be-used-with-metabase.md b/docs/faq/general/what-languages-can-be-used-with-metabase.md index 4e70f4d159f..575d64d74cc 100644 --- a/docs/faq/general/what-languages-can-be-used-with-metabase.md +++ b/docs/faq/general/what-languages-can-be-used-with-metabase.md @@ -1,24 +1,39 @@ # What languages can be used with Metabase? -Thanks to our amazing user community, Metabase has been translated into a variety of languages. Due to the nature of how we collect translations (more on that in a minute), available languages may be added or removed during major releases, depending on the translation coverage. - -The available languages as of the 0.33 release are: - -* Catalan -* Dutch -* French -* German -* Italian -* Japanese -* Norwegian Bokmål -* Polish -* Portuguese -* Spanish -* Russian -* Turkish -* Ukranian -* Vietnamese - -Metabase translations are collected via a [POEditor project](https://poeditor.com/join/project/ynjQmwSsGh). In order for a language to be added to Metabase as a supported language, it has to achieve 100% translation. If a language falls below 90% translation, we will remove it from Metabase until it returns to being 100% translated. We make sure to alert the POEditor community a few weeks ahead of a major release if there are languages in danger of being removed from Metabase, and the language coverage can be viewed on the POEditor project page at any time. - -Note that while we will only remove languages during major releases, we will add them back in during minor releases - so it's always a good time to jump in and start translating! +Thanks to our amazing user community, Metabase has been translated into a variety of languages. Due to the nature of how we collect translations (more on that in a minute), available languages may be added or removed during major releases, depending on the translation coverage. + +## Currently available languages + +The available languages as of the 0.35 release are: + +- Catalan +- Chinese, simplified +- Chinese, traditional +- Dutch +- French +- German +- Italian +- Japanese +- Persian +- Polish +- Portuguese +- Spanish +- Russian +- Slovak + +Some translations were previously available in Metabase, but have been removed as they are no longer complete: + +- Norwegian Bokmål +- Turkish +- Ukrainian +- Vietnamese + +## Policy for adding and removing translations + +The community contributes to Metabase translations on our [POEditor project](https://poeditor.com/join/project/ynjQmwSsGh). If you're a fan of Metabase and would like to see it made available in a language you're fluent in, we'd love your help! + +For new translations to be added to Metabase they must reach 100%. Once they have, we'll add them in the next major or minor release of Metabase. All _existing_ translations in Metabase _must stay at 100%_ to continue being included in the next _major_ version of Metabase. This is to ensure that no one encounters a confusing mishmash of English and another language when using Metabase. + +We understand that this is a high bar, so we commit to making sure that before each major release, any additions or changes to text in the product will be completed at least 10 calendar days before the final release ships, at which point we notify all translators that a new release will be happening soon. + +Note that while we will only remove languages in major releases, we will add them back in for minor releases — so it's always a good time to jump in and start translating! diff --git a/docs/faq/general/what-languages-is-metabase-compatible-with.md b/docs/faq/general/what-languages-is-metabase-compatible-with.md deleted file mode 100644 index 4e70f4d159f..00000000000 --- a/docs/faq/general/what-languages-is-metabase-compatible-with.md +++ /dev/null @@ -1,24 +0,0 @@ -# What languages can be used with Metabase? - -Thanks to our amazing user community, Metabase has been translated into a variety of languages. Due to the nature of how we collect translations (more on that in a minute), available languages may be added or removed during major releases, depending on the translation coverage. - -The available languages as of the 0.33 release are: - -* Catalan -* Dutch -* French -* German -* Italian -* Japanese -* Norwegian Bokmål -* Polish -* Portuguese -* Spanish -* Russian -* Turkish -* Ukranian -* Vietnamese - -Metabase translations are collected via a [POEditor project](https://poeditor.com/join/project/ynjQmwSsGh). In order for a language to be added to Metabase as a supported language, it has to achieve 100% translation. If a language falls below 90% translation, we will remove it from Metabase until it returns to being 100% translated. We make sure to alert the POEditor community a few weeks ahead of a major release if there are languages in danger of being removed from Metabase, and the language coverage can be viewed on the POEditor project page at any time. - -Note that while we will only remove languages during major releases, we will add them back in during minor releases - so it's always a good time to jump in and start translating! diff --git a/docs/faq/start.md b/docs/faq/start.md index 88b0dedea26..a366bcf45bd 100644 --- a/docs/faq/start.md +++ b/docs/faq/start.md @@ -12,8 +12,9 @@ Here is a list of some frequently asked questions about Metabase. - [Is Metabase accessible or 508 compliant?](general/is-metabase-508-compliant.md) - [Do we need a Data Processing Agreement with Metabase to comply with GDPR?](general/do-we-need-a-data-processing-agreement.md) - [What browsers does Metabase support?](general/supported-browsers.md) +- [Which languages is Metabase available in?](general/what-languages-can-be-used-with-metabase.md) -## Set-up and Admin Questions +## Setup and Admin Questions - [Which databases does Metabase support?](setup/which-databases-does-metabase-support.md) - [I'm having trouble running Metabase.](setup/i-am-having-trouble-running-metabase.md) -- GitLab