1
0
Fork 0

feat: Flat import of markdown repo

This is a flat (without history) import of (some of) the content
from our markdown module.

We've imported this without history because the repo contains our
blog posts and showcases posts content prior to porting them to strapi.

Since this contains many images, it would balloon the size of this repo
to import the full history.

Instead, please refer to the history of the (archived) markdown repo
at: https://github.com/freesewing/markdown
This commit is contained in:
Joost De Cock 2021-08-25 16:09:31 +02:00
parent 1671a896b5
commit b34a2ee2ed
6132 changed files with 244167 additions and 0 deletions

View file

@ -0,0 +1,19 @@
---
title: freesewing.dev
order: 20
---
The content for our freesewing.dev website is stored in the `dev` folder
of [our Markdown repository](https://github.com/freesewing/markdown/).
Each page is in its own folder and contains an `en.md` file.
All images and other media used by the page/post will also be contained in the folder.
<Note>
You might still see some files from other langauges (like `es.md`, `fr.md`, `de.md`, or `nl.md`) that
predate the decision to only provide freesewing.dev in English.
You can remove those files.
</Note>

View file

@ -0,0 +1,16 @@
---
title: Emails
order: 50
---
By *emails* we mean the kind of automated emails that are sent out by
the FreeSewing backend. Like when you sign up, or ask for a password reset
and so on.
The content of these emails comes from the `src/templates` folder
of [our backend repository](https://github.com/freesewing/backend).
However, most of the actual text that the user gets to see is defined in one of
the YAML files of our i18n package (specifically `email.yaml).
See [strings](/editors/content/strings/) for more details.

View file

@ -0,0 +1,9 @@
---
title: Content sources
---
As an editor, you need to know where you can find/edit what type of content.
Below is a list of all our content sources:
<ReadMore list />

View file

@ -0,0 +1,6 @@
---
title: Newsletter
order: 40
---
<Fixme>Under construction</Fixme>

View file

@ -0,0 +1,35 @@
---
title: freesewing.org
order: 10
---
The content for our freesewing.org website is stored in the `org` folder
of [our Markdown repository](https://github.com/freesewing/markdown/).
Within it, you will find the following 4 subfolders:
- `org/blog`: Holds the freesewing.org blog posts
- `org/docs`: Holds the freesewing.org documentation (everything under `/docs` on the site)
- `org/showcase`: Holds the freesewing.org showcase posts
- `org/ui`: Holds snippets of text used throughout the UI that are too large or volatile to be translated as strings
Each page or post is in its own folder that contains the following five files:
- `de.md`: The German version
- `en.md`: The (original) English version
- `es.md`: The Spanish version
- `fr.md`: The French version
- `nl.md`: The Dutch version
All images and other media used by the page/post will also be contained in the folder.
<Note>
##### Edit, don't translate
As an editor, you only ever work with the `en.md` files. The rest is for the translators.
When creating new content, you don't have to create the other files, only `en.md`.
The rest will be created automatically.
</Note>

View file

@ -0,0 +1,32 @@
---
title: Strings
order: 30
---
With *strings* we mean all of the translation stored in [our i18n package](/reference/pacakges/i18n) that
provides internationalization.
They are a number of YAML files that you can find in the `packages/i18n/src/locales/en` folder of
[our monorepo](https://github.com/freesewing/freesewing/)
These files are typically the domain of translators, as they contain short strings and snippets of
text used throughout the software/website rather than flowing text.
However, as an editor, it's good to know where they live.
<Note>
##### Beware that making changes will have ripple-effects on translation
If you make a change to one of the (English) YAML files, this will have a knock-on
effect on translators as this string now needs to be re-translated.
</Note>
<Warning>
Never make changes in the non-English files as they will simply be
overwritten by our translation software.
</Warning>