diff --git a/markdown/dev/guides/best-practices/en.md b/markdown/dev/guides/best-practices/en.md index 4535cee8f8e..be23d9a888a 100644 --- a/markdown/dev/guides/best-practices/en.md +++ b/markdown/dev/guides/best-practices/en.md @@ -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: diff --git a/markdown/dev/guides/patterns/en.md b/markdown/dev/guides/patterns/en.md index 503a1045fcb..2b63ade77bd 100644 --- a/markdown/dev/guides/patterns/en.md +++ b/markdown/dev/guides/patterns/en.md @@ -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. diff --git a/markdown/dev/guides/translation/empty/en.md b/markdown/dev/guides/translation/empty/en.md deleted file mode 100644 index 4a8ea431620..00000000000 --- a/markdown/dev/guides/translation/empty/en.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: " " ---- - -This page was intentionally left blank. diff --git a/markdown/dev/guides/translation/en.md b/markdown/dev/guides/translation/en.md index 72723cec216..137120af3de 100644 --- a/markdown/dev/guides/translation/en.md +++ b/markdown/dev/guides/translation/en.md @@ -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. + + + +##### 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 + + + + +## Languages We currently support the following five languages: @@ -16,35 +41,65 @@ We currently support the following five languages: 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). -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** -##### 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. +### 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. diff --git a/markdown/dev/howtos/ways-to-contribute/en.md b/markdown/dev/howtos/ways-to-contribute/en.md index 79deddb0d46..6c8e182224b 100644 --- a/markdown/dev/howtos/ways-to-contribute/en.md +++ b/markdown/dev/howtos/ways-to-contribute/en.md @@ -3,67 +3,52 @@ title: Ways to contribute --- Thank you for being part of our community, and for wanting to contribute! ❤️ - FreeSewing is an open source project ran by volunteers from different corners of the world. -We would love to have you on board, but before we get to that, let's look at what we expect from you: +We would love to have you on board, and this page lists everything you need to know to get started. - +## Requirements -##### Contributor requirements +The only requirement we ask from our contributors is that they are the kind of people who +value a safe and welcoming environment for all members of the FreeSewing community. - - Please respect [our community standards](https://freesewing.org/docs/various/community-standards/) - - As a contributor, you must uphold [our Code of Conduct](/contributors/code-of-conduct/) +To that extend, we impose the following requirements to ensure everyone feels safe and welcome: - + - Any member of our community must respect [our community standards](https://freesewing.org/docs/various/community-standards/) + - As a contributor, you must uphold [our Code of Conduct](/guides/code-of-conduct/) + +Go ahead and read those, we'll wait. + +## Good to know With that out of the way, here's a few more things that are *good to know*: - - -##### Did you know? - - Nobody gets paid to work on/for FreeSewing. We are a 100% volunteer organisation. - - We have patrons who support us financially, but all the money that comes in goes to charity -- + - We have patrons who support us financially, but all the money that comes in goes to charity — See our [revenue pledge](https://freesewing.org/docs/various/pledge/) for details + - FreeSewing follows the [all-contributors](https://allcontributors.org/) specification. + Contributions of any kind are welcome. - +## Where to begin +Below is a list of ideas or roles you could take up. +If you're not sure what to do, or if you have questions, [please reach out to +us](https://discord.freesewing.org/). -With the formalities out of the way, please continue -to [Ways to contribute](/contributors/ways-to-contribute) -or [Where to get help](/contributors/help/). + - - - -##### Looking to hit the ground running? - -You can start with [our project board](https://todo.freesewing.org/), or -going through the issues labeled [good first issue](https://github.com/freesewing/freesewing/issues?q=is%3Aissue+is%3Aopen+label%3A%22%F0%9F%91%8D+good+first+issue%22). - -Don't be afraid to take on an issue. If you get stuck, [we'll help you out](https://discord.freesewing.org/). - - - -Unsure where to begin contributing to FreeSewing? -*Contributing* can take on many shapes and forms. -There's certainly a way that works well for you. - -Here's a non-exhaustive list: - - - - + ##### Who wants a job in the tech sector? For many in our community, contributring to FreeSewing marked their first steps into the world of open source software development. -We are happy to provide guidance to anyone who wants to learn, -especially when doing so enables upwards social mobility. +I (joost) am happy to provide guidance or mentorship to anyone who +wants to learn, especially when doing so enables upwards social mobility. - +[Reach out](https://discord.freesewing.org/) and we let's do this. + + diff --git a/markdown/dev/reference/plugins/export-dxf/en.md b/markdown/dev/reference/plugins/export-dxf/en.md index 6fb40254d15..fd1ff8be614 100644 --- a/markdown/dev/reference/plugins/export-dxf/en.md +++ b/markdown/dev/reference/plugins/export-dxf/en.md @@ -8,9 +8,9 @@ It will attach the [the postDraft lifecycle hook](/reference/api/hooks/postdraft) to add a `renderDxf()` method to the pattern object. - + -##### Maintainer note: This is de-facto unmaintained +##### This is de-facto unmaintained This plugin is de-facto unmaintained because I have no use for it. I keep it around in case it might be useful, and I've used it @@ -19,7 +19,7 @@ myself for exporting to different software. The being said, DXF is a poor choice as a file format for storing sewing patterns. For one thing, it only allows straight lines, no curves. Yikes! - + ## Installation