chore(markdown): More dev updates
This commit is contained in:
parent
046f6668e2
commit
e8c5062217
6 changed files with 102 additions and 95 deletions
|
@ -1,18 +1,5 @@
|
|||
---
|
||||
title: Design guide
|
||||
order: 300
|
||||
for: developers
|
||||
icons:
|
||||
- thumbup
|
||||
- pattern
|
||||
about: "There's often many different ways to do things. Learn about our conventions and best practices"
|
||||
goals:
|
||||
- Re-using measurement and options names
|
||||
- Re-using CSS classes
|
||||
- Respecting draft settings
|
||||
- Using percentage options where possible
|
||||
- Using translation keys for text
|
||||
- Constructing paths counter-clockwise
|
||||
title: Pattern design best practices
|
||||
---
|
||||
|
||||
Here is a list of best practices when designing patterns:
|
||||
|
|
|
@ -1,20 +1,5 @@
|
|||
---
|
||||
title: How patterns work
|
||||
order: 200
|
||||
for: contributors
|
||||
icons:
|
||||
- blocks
|
||||
- pattern
|
||||
about: |
|
||||
Learn about the main building blocks that make up a FreeSewing pattern
|
||||
goals:
|
||||
- Learn about points
|
||||
- Learn about paths
|
||||
- Learn about snippets
|
||||
- Learn about parts
|
||||
- Learn about the pattern configuration
|
||||
- Learn about the pattern store
|
||||
- Learn about the pattern itself
|
||||
---
|
||||
|
||||
This short guide will illustrate and explain how patterns work in FreeSewing.
|
||||
|
|
|
@ -1,5 +0,0 @@
|
|||
---
|
||||
title: " "
|
||||
---
|
||||
|
||||
This page was intentionally left blank.
|
|
@ -1,9 +1,34 @@
|
|||
---
|
||||
title: For translators
|
||||
order: 1140
|
||||
title: Translation guide
|
||||
---
|
||||
|
||||
Freesewing is proudly multilingual. We currently support 5 languges:
|
||||
Freesewing.org is proudly multilingual, and we currently support five languges.
|
||||
For this, we rely on the work for our translators who volunteer their
|
||||
time to translate FreeSewing into various languages from English, which
|
||||
is our source language.
|
||||
|
||||
This translation guide will tell you everything you need to
|
||||
know to join the effort as a translator for FreeSewing.
|
||||
|
||||
<Tip>
|
||||
|
||||
##### TL;DR: Becoming a FreeSewing translator
|
||||
|
||||
Our translation project on Crowdin is accessible
|
||||
via [translate.freesewing.org](https://translate.freesewing.org).
|
||||
|
||||
To get started, you will need to be invited as a translator. No need to worry,
|
||||
simply [let us know you'd like to help out](https://discord.freesewing.org/) and we'll add you.
|
||||
|
||||
For access to Strapi, you will need an account on [our Strapi instance](https://posts.freesewing.org/).
|
||||
Here too, [Discord is the place to let us know you'd like to help out](https://discord.freesewing.org/).
|
||||
|
||||
Bonus: You'll get an `@freesewing.org` email alias
|
||||
|
||||
</Tip>
|
||||
|
||||
|
||||
## Languages
|
||||
|
||||
We currently support the following five languages:
|
||||
|
||||
|
@ -16,35 +41,65 @@ We currently support the following five languages:
|
|||
<Note>
|
||||
|
||||
If you'd like to start working on a new language, that's great, but a bit
|
||||
beyond the scope of this documentation. So in that case,
|
||||
beyond the scope of this documentation. Before you start working on a new language
|
||||
please [come and talk to us on Discord](https://discord.freesewing.org).
|
||||
|
||||
</Note>
|
||||
|
||||
For content hosted on [Strapi](/editors/content/#strapi), translation is available within Strapi as different language versions of the same post.
|
||||
## Translation in Crowdin vs Strapi
|
||||
|
||||
For markdown content and strings, we use [crowdin](https://crowdin.com/) to manage translations.
|
||||
It's an online platform that makes translation a breeze.
|
||||
We use two different tools to manage our translations, depending on the context:
|
||||
|
||||
There's a good deal of documentation on Crowdin online, so we won't try to replicate that here.
|
||||
You can access the Crowdin project at: [translate.freesewing.org](https://translate.freesewing.org).
|
||||
|
||||
To get started, you will need to be invited as a translator. No need to worry,
|
||||
simply [let us know you'd like to help out](https://discord.freesewing.org/) and we'll add you.
|
||||
- Markdown content and code strings in our monorepo are translated within **Crowdin**
|
||||
- Blog and showcase posts are translated within **Strapi**
|
||||
|
||||
<Tip>
|
||||
|
||||
##### English as origin language, and differences between Crowdin and Strapi
|
||||
##### Translation priorities
|
||||
|
||||
Our content comes in two flavors:
|
||||
If you'd like to help out, please join our translation team on Crowdin.
|
||||
|
||||
- Strings and markdown content **on Crowdin**. Here, English is the **origin language** and
|
||||
translations are kept close to the origin.
|
||||
- Blog posts and showcases **on Strapi**. Here, there is no origin langauge. People can write
|
||||
blog posts in any language, or translate more freely to adapt the content to a different audience.
|
||||
While it can be nice to have blog and showcase posts translated, the are less important than the
|
||||
translation work in Crowdin which is about the documentation and strings that allow people to
|
||||
use FreeSewing.org in a different language.
|
||||
|
||||
</Tip>
|
||||
|
||||
### Crowdin
|
||||
|
||||
Most translation happens in Crowdin ([crowdin.com](https://crowdin.com/)), and online translation platform
|
||||
that makes translation and collaboration a breeze.
|
||||
|
||||
In Crowdin, all text is broken up into lines words or paragraphs, that are than translated.
|
||||
This does not only facilitate collaboration — as rather than work on one large block of text
|
||||
various people can jump in and translate smaller snippets — it also enforces a strict one-on-one
|
||||
match between the English source material and the translation.
|
||||
|
||||
This strict correlation is important. People who refer to the documentation in a different language
|
||||
expect to find the same structure, the same amount of headings, paragraphs and so on.
|
||||
|
||||
### Strapi
|
||||
|
||||
Strapi ([strapi.io](https://strapi.io/)) is a so-called *headless content management system (CMS)*.
|
||||
Headless just means that we load the content from it via an API, rather than have it be part of our
|
||||
website like a classic CMS (eg. Wordpress).
|
||||
|
||||
In Strapi, we keep our blog posts and showcases for FreeSewing.org.
|
||||
We also keep our newsletter editions there and developer blog posts for FreeSewing.dev there, but since
|
||||
those are not translated, we will ignore them in this guide.
|
||||
|
||||
Strapi supports different language versions for posts, but it's not a translation system like Crowdin
|
||||
that breaks text down into small parts to translate.
|
||||
Instead, each post can be translated as a whole, and there is not enforcement whatsover of structure or
|
||||
content between the different language versions.
|
||||
|
||||
In other words, a translated blog posts could use a different structure, or even different images.
|
||||
This is by design, because we want to encourage the different (non-English) FreeSewing communities
|
||||
to make FreeSewing their own, by writing blog posts that are relevant or specific to them.
|
||||
|
||||
This also means that English does not have to be the source language in Strapi.
|
||||
Somebody could write a French blog post (for example) which can then be translated to English.
|
||||
|
||||
## Syntax
|
||||
|
||||
Most strings are just text, but sometimes you'll find a little markup sprinkled in.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue