Skip to content
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.

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

Create documentation about installing Backdrop in different languages #523

Open
olafgrabienski opened this issue Apr 5, 2019 · 15 comments

Comments

@olafgrabienski
Copy link

In the installer, we link to http://drupal.org/localize for more information on installing Backdrop in different languages. As part of Switch the translation links in the installer from drupal.org to backdropcms.org, we want to link to our own documentation page, but such a page doesn't exist on backdropcms.org.

@olafgrabienski
Copy link
Author

olafgrabienski commented Apr 5, 2019

While the drupal.org page Install Drupal in another language is a sub page of the "Installing Drupal 7" pages, the Backdrop Installation instructions are all on one page. On this page, installing BD in another language is mentioned as part of the "Run the installer" steps:

  1. Choose language
    If you want to install using a language other than English, click the Learn how to install Backdrop in other languages link.

Suggestions:

  • remove the hint to the Learn how to ... link
  • point to more information on the same page instead (see next suggestion)
  • add the install in another language documentation in a separate section, or as part of the "Troubleshooting / Additional steps" section

(Mid-term it might be useful to split the *Installation instructions" in sub pages, as Drupal does.)

@olafgrabienski
Copy link
Author

Here's a draft of the documentation text, only the needed steps, wording to be improved:

Add a language before installing Backdrop

  • Download the language file from the translation server.
  • Move the downloaded .po file inside the directory files/translations.
  • Install Backdrop as per usual.

Add a language after installing Backdrop

  • Go to Functionality > List Modules, and ensure that the Locale module is enabled.
  • Go to Configuration > Regional and language > Languages, click the "Add language" link, select your language, and click the "Add language" button.
  • Download the language file from the translation server.
  • Go to Configuration > Regional and language > User interface translation > Import. Upload and import the language file using the form.

@olafgrabienski
Copy link
Author

@klonos @jenlampton I'd love to get feedback on the documentation suggestions above. When we have an agreement about the text, can I edit the documentation pages (permission-wise), or do you want to do it?

Note: We first need the documentation on b.org before I can file a pull request for backdrop/backdrop-issues#3560.

@olafgrabienski olafgrabienski changed the title Create a documentation page about installing Backdrop in different languages Create documentation about installing Backdrop in different languages Apr 5, 2019
@jenlampton
Copy link
Member

@olafgrabienski I have added your content to a page on b.org:
https://backdropcms.org/user-guide/install-backdrop-another-language

You should have permission to edit this page.

@herbdool
Copy link

herbdool commented Apr 7, 2019

@olafgrabienski maybe it should be clearer that if the Backdrop server doesn't have a complete translation they can download ones from Drupal for some coverage.

Also, not sure where to put info on how to contribute translations.

@olafgrabienski
Copy link
Author

@herbdool Good points, will consider them when I edit the page, hopefully tomorrow.

@olafgrabienski
Copy link
Author

olafgrabienski commented Apr 8, 2019

I've updated the page https://backdropcms.org/user-guide/install-backdrop-another-language, primarily added an intro text. (Not yet visible when not logged in. I have cleared the "Page and else" cache, though.)

@herbdool In my opinion, information about Drupal language files and about contributing to Backdrop translations should live on https://localize.backdropcms.org/. It's actually there, in the Welcome text, but still very basic and definitely to be improved.

(More) information about Drupal language files should e.g. also displayed on https://localize.backdropcms.org/translate and sub pages.

The contribution workflow is still not very clear. When it is, I'll add that information.

@olafgrabienski
Copy link
Author

@herbdool I forgot to mention that there is also a "How to contribute translations" documentation issue: #507

@olafgrabienski
Copy link
Author

In backdrop/backdrop-issues#3560 (comment) @quicksketch suggested to remove the /user-guide part from the URL of the page. Instead of

https://backdropcms.org/user-guide/install-backdrop-another-language

the URL would be:

https://backdropcms.org/install-backdrop-another-language

@olafgrabienski
Copy link
Author

olafgrabienski commented Apr 10, 2019

@jenlampton or @klonos - Can you remove the /user-guide part of the URL, changing the URL alias to just /install-backdrop-another-language? I don't have the permissions.

@jenlampton
Copy link
Member

@olafgrabienski
Copy link
Author

https://backdropcms.org/installing-in-other-languages

Looks good, thank you!

@docwilmot
Copy link
Contributor

Just curious, as I've never installed in another language, but

Add a language before installing Backdrop
Download the language file from the translation server.
Move the downloaded .po file inside the directory files/translations.
Install Backdrop as per usual.
You'll find your language on the page Configuration > Regional and language > Languages.

Doesn't this process change the installation steps at all (does Backdrop not prompt you to choose a language during install or something?) and if so, the steps should mention that. Like step 3 "you will be prompted to choose a language" etc

@olafgrabienski
Copy link
Author

Doesn't this process change the installation steps at all (does Backdrop not prompt you to choose a language during install or something?) and if so, the steps should mention that.

Good point! The information is on the general installation page but we should add it here as well. I'll update the page tomorrow.

@olafgrabienski
Copy link
Author

olafgrabienski commented Apr 16, 2019

@docwilmot Thanks for the hint yesterday. I've tested the installation process and have updated the documentation.

(I've also noticed that files from the Backdrop localization server currently need to be renamed -- in contrast to Drupal files (fixed for them in backdrop/backdrop-issues#2345) --, here's the respective issue: backdrop/backdrop-issues#3674)

Part of the current text:

Add a language before installing Backdrop

  • Download the language file from the translation server.

  • Move the downloaded .po file inside the directory files/translations.

  • Rename the file to install.(languagecode).po.
    Example: Rename backdropcms-1.12.2.es.po to install.es.po.

  • Install Backdrop as per usual.
    The installer will guide you through several steps.
    During the first step, you will be prompted to choose a language.

  • Choose your language, and click to continue the installation.
    During some of the next steps, the installer will import your translations.

    After the installation you will be redirected to your site's home page.
    You'll find your language ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants