standard-for-public-code / community-translations-standard

Unofficial translations of the Standard for Public Code, provided by the community.

Community translations of the Standard for Public Code

This is a repository for unofficial translations of the Standard for Public Code, provided by the community.

Contribute

Anyone may start a translation of the standard. Please place your translation in a folder named with an RFC 5646 language code (for example es for Spanish or da for Danish or zh_Hant_TW for Chinese with traditional script for the Taiwan locale).

In order for our scripts that generate pdf's to work as easily as possible, do not translate file names, folder names or the front matter.

You may use script/new-translation.sh to get started. This script copies the English files into the translation folder that you specify.

In the pull request, also remember to update the table in index.md with a link to the translation and what version this is a translation of.

Files to translate

These are the files that need to be translated before it is ready for review.

• index.md
• all files in the folder criteria except for _template.md
• readers-guide.md
• glossary.md
• CODE_OF_CONDUCT.md
• CONTRIBUTING.md
• GOVERNANCE.md
• CHANGELOG.md
• AUTHORS.md
• standard-print.html
• print-cover.html

While standard-print.html and print-cover.html are large files, the only text that needs to be translated are the ones in the table below (some in two places in the file).

English text
Request for contributions
Standard for Public Code
Table of Contents
Authors
Readers guide
Glossary
Criteria
Contributing guide
Code of conduct
Governance
Version history
License
Contact
This license is the legal contract that allows anyone to do anything they like with the content in this entire document.
For questions and more information about our organization you can find us at our website, email us at [email protected], or call us at [phone]
The Standard for Public Code supports the collaborative creation of codebases that are usable, open, legible, accountable, accessible and sustainable.
The Standard includes guidance to policymakers, managers, designers and developers creating and managing codebases.
The standard specifies the criteria:
Request for contributions
What public code is and how to implement it for:
Public policy makers
Managers
Developers and designers
Draft
Version

The license need not be translated since that is just copied from another project. If there is a translation available in the target language for it, it may be included. If a translation of the license is not available yet, but you really need it, we encourage you to translate it upstream. That way it will benefit more people and you will get help of a community that know the license well.

Foreword

There is also foreword.md that gives context about the concept of Public Code. The foreword may be translated or even customized for a locale's context.

Review of a translation

Before we merge a pull request of a new or updated translation it need to be reviewed. This should be done by a native speaker coming from a different context than the person submitting the pull request.

Problems, suggestions and questions in issues

You can report problems, suggest changes or ask questions by creating a GitHub issue for this project in the GitHub Issues for community translations. Or, sign up to the Standard for Public Code mailing list and send an email to [email protected].

Preview, build and deploy

We are still figuring out the details this process. Please be patient.

Code of Conduct

This repository uses a code of conduct, please respect it.

License

All translations must be submitted under CC0 1.0.

community-translations-standard's Issues

Script a bootstrap start

It would be nice if there was a script that cloned the standard and the translation repos and copied the relevant files into a folder. That would make it quicker to get started.

Add a markdown linter

To make sure the markup is solid, we should add the same linter as we have on the Standard itself.

Process for generating pdf

We should decide the details of how we want to generate a pdf. Are we copying files from the standard repository to each language folder or do we have a central script etc.

Change language folder name system

Currently, we specify ISO 639-1 as a standard for naming the folders for translation. However, it does not specify which script to use, which in some cases is important.

Therefore, I suggest that we change this to RFC 5646 (which also adds the possibility to add a locale if needed).

As the RFC does not require all levels to be specified, current folders does not need to be renamed with this change as the language part of the tag is compatible with ISO 639-1.

Swedish translation

Would be happy to contribute to a Swedish translation of the standard. Thoughts? Anyone else want to collaborate in this?

CODE_OF_CONDUCT and LICENSE not on the list of files to be translated

From the files linked in https://standard.publiccode.net/, CODE_OF_CONDUCT and LICENSE are not listed in https://github.com/publiccodenet/community-translations-standard/blob/main/README.md to be translated. Is that a mistake or by intention?
If a mistake, besides the obvious correction of the above README.md, how do we update the translators and the translations (e.g. my scripts in the PR 23 do not include them), and what has to be corrected in the workflow?
If by intention, what is the reason?
(BTW, when opening this Issue, as it is the first one for this project, I was reminded to review the code of conduct.)

Expand the README

So that people finding the repository know what it is about.

Update to 0.7.0

Diff from 0.6.0

Add more details on how translations should look like

More details need to be added to the README for people to be able to contribute:

• What should the folder structure be like?
• Do we translate file names?
• Which files need to be translated?
• Is any specific front matter required?
• How do we review a translation, what's a good release process?

Serving the translations on gh-pages

Find a way to get the contributed translations be available in a rendered interface, similarly to how the standard is.

Add calls to action to community translations index

This page, linked to from the Standard index, is unnecessarily unhelpful if you're enthusiastic but not looking for Spanish. It would be easy to add:

• an overview of other in-progress translations
• a link to getting started in your language
• an invitation/welcome/expression of appreciation for existing translations

Update to reflect language about authoritative and courtesy translations

In version 0.8.0, we tweaked the language for translations, we should reflect that here.

Add the Danish translation

We have received text from OS2, let's add it here.

Text in `es/images/audit-flow.svg` needs translation

Text is currently in en, to re-generate the svg with es or other language text, I'd like to document the process for creating the svg.

Some questions leap to mind:

• Can we use SVG's localization and internationalization to make a single version?
• Is there "source code" for the diagram which is transformed to make the .svg?
• What is the original "source" for the image?
• What additional tooling is needed to edit the diagram, including the strings?

Recommend workflow?

A question asked in #15 was about the recommended workflow. Is it easiest to fork the repository of the Standard for Public Code, make changes, and then make a pull request towards this repository? Or is there some other way that we believe would be easier?

Either way, we should probably describe in the README what might be a good way of doing it, noting that we are not prescriptive in how it is being done.

Documenting how we handle versioning

We should write down in the README how we want to handle versioning of the translations (that is, how do we show/know which version is translated).