From 67d33ed53748747208f4f82556d3fca7e09fd2da Mon Sep 17 00:00:00 2001 From: peartown Date: Mar 25 2024 23:25:36 +0000 Subject: New file hosting.adoc added relevant changes made to: index.adoc nav.adoc --- diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index c0490da..296b0a8 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -2,3 +2,4 @@ * xref:weblate.adoc[How to use Weblate] * xref:transtats.adoc[How to use Transtats] * xref:doc_l10n.adoc[Documentation Translation Workflow] +* xref:hosting.adoc[Translation projects in Weblate] diff --git a/modules/ROOT/pages/hosting.adoc b/modules/ROOT/pages/hosting.adoc new file mode 100644 index 0000000..008470e --- /dev/null +++ b/modules/ROOT/pages/hosting.adoc @@ -0,0 +1,83 @@ +include::{partialsdir}/attributes.adoc[] + +// hosting.adoc? - is there a better file name for this page, will be part of URL? + += Translation projects in Weblate + +== Fedora's online translation platform + +The Fedora Project runs {WEBLATE}[a Weblate instance] available at {WEBLATE}, which is used for translation of Fedora subprojects be it a software development project, a website or the documentation. + +=== Considerations to upstream projects + +In line with its vision of "a world where everyone benefits from free and open source software built by inclusive, welcoming, and open-minded communities" any free and open source software project is welcome to use this platform. + +Few examples of motivation behind this approach: + +* We support any project sharing the same values as the Fedora Project +* To improve upstream i18n support +* A potential source of growth in the Fedora Community itself + +As the Fedora l10n Team, we believe we are enough _"`mature and consistent with our values to be ready to welcome projects which have different technical choices from those the Fedora implements`"_ (Jean-Baptiste Holcroft, a member of the Fedora l10n Team, 2020). + +//// +What makes us different with https://hosted.weblate.org? + +We are a structured community sharing open-source values with +experienced translators +* Structured community: we have language teams +https://fedoraproject.org/wiki/L10N_Teams and a global translator +mailing list +https://lists.fedoraproject.org/archives/list/trans@lists.fedoraproject.org/ +* we have open-source values: +https://docs.fedoraproject.org/en-US/project/#_freedom + +Rule examples: +* announce translation readiness to translators one week before release? +* include translators in credits +* allow translation of website and man-pages +//// + + +== Request a new translation project on Weblate + +In spite of the effort to be open and inclusive as much as possible, some associated concerns has led us to enforce it is not possible to create a translation project in the platform for everyone: + +* A translation of an (open source) project has to be ensured +_Not what an individual has decided to translate._ +* A project does not have to learn the weblate internals +* Configuring Weblate is not so obvious +_Preferable is to do the first configuration for a project by us to reduce e.g. the migration costs._ + +To make a request to set up a new translation project in {weblate}[Weblate], open a link:https://pagure.io/fedora-l10n/tickets[ticket]. + +// Do we want to prepare a 'request template'? +.Project request template +[example] +Project: // debbuild +Website: //https://github.com/debbuild/debbuild +Repository: //https://github.com/debbuild/debbuild +Name of the development branch: +Filemask: //po/* +Username: //ngompa +Optional: +Any announcement/warning you would like to display to the translators? (it will be displayed in Weblate) +A need to activate any specific checks? (this is a setting per component) +A need to automatically detect new translation files? (typical usecase: website translation with one translation file per page) + +// These features has already been implemented in Weblate +//// +two features in Weblate to respect Fedora values: +- set a lincence in every component +- licence change should trigger a notification +//// +// Should be a licence a part of the template? +// [optional] what is the license of translation? (please use a code from https://spdx.org/licenses/) +// Should we emphasize that a licence change will be notified + +The specified username(s) will be set in the initial configuration of the project in Weblate as the project's administrator(s). + +Once the initial configuration is made you will be notified. + +Request made by upstream projects will be reviewed on an individual basis upon submission of the ticket. Priority will be given to projects that create software packaged for Fedora. // or 'by Fedora'?? + diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index b3f6e70..1ee9295 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -20,16 +20,8 @@ Questions or problems associated with localization can be filed as an issue in h == Next reading -Translators can continue with reading information on xref:join.adoc[membership] of this team and our online xref:weblate.adoc[translation platform]. +Translators can continue with reading information about a xref:join.adoc[membership] of this team and our little guide to our online xref:weblate.adoc[translation platform]. -Some insights into our translation tooling can be found xref:doc_l10n[here]. -Projects that are considering the use of our translation platform for their translations might find relevant information here. - -== Request a new translation project on Weblate - -- Translations can be hosted at link:https://translate.fedoraproject.org/[Fedora Weblate instance]. + -To make a request for a new translation, open a link:https://pagure.io/fedora-l10n/tickets[ticket]. - -- It is possible to host translations for any open source projects. -These will be reviewed on an individual basis upon submission of a link:https://pagure.io/fedora-l10n/tickets[ticket]. -Priority will be given to projects that create software packaged for Fedora. +Some insights into our translation tooling used in the Fedora Project, for example for translating the https://docs.fedoraproject.org[Fedora documentation] can be found xref:doc_l10n.adoc[here]. + +Projects that are considering the use of our translation platform for their translations might find relevant information xref:hosting.adoc[here].