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:
parent
1671a896b5
commit
b34a2ee2ed
6132 changed files with 244167 additions and 0 deletions
25
markdown/dev/contributors/code-of-conduct/en.md
Normal file
25
markdown/dev/contributors/code-of-conduct/en.md
Normal file
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
title: Code of Conduct
|
||||
for: contributors
|
||||
icons:
|
||||
- face
|
||||
- heart
|
||||
about: |
|
||||
FreeSewing's code of conduct is based on the [contributor covenant](https://www.contributor-covenant.org/)
|
||||
---
|
||||
|
||||
<ReadMore title="The FreeSewing Code of Conduct" />
|
||||
|
||||
<Tip>Upholding our Code of Conduct is a requirement for all FreeSewing contributors</Tip>
|
||||
|
||||
<Note>
|
||||
|
||||
##### Attribution
|
||||
|
||||
This Code of Conduct is an almost verbatim copy of the [Contributor Covenant][homepage], version 2.0,
|
||||
available at [http://contributor-covenant.org/version/2/0][version]
|
||||
|
||||
[homepage]: http://contributor-covenant.org
|
||||
[version]: http://contributor-covenant.org/version/2/0/
|
||||
|
||||
</Note>
|
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
title: Correction
|
||||
order: 10
|
||||
---
|
||||
|
||||
##### Community Impact
|
||||
Use of inappropriate language or other behavior
|
||||
deemed unprofessional or unwelcome in the community.
|
||||
|
||||
##### Consequence
|
||||
A private, written warning from community leaders,
|
||||
providing clarity around the nature of the violation and an
|
||||
explanation of why the behavior was inappropriate.
|
||||
|
||||
A public apology may be requested.
|
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
title: Enforcement Guidelines
|
||||
order: 60
|
||||
---
|
||||
|
||||
Community leaders will follow these Community Impact Guidelines
|
||||
in determining the consequences for any action they deem
|
||||
in violation of FreeSewing's Code of Conduct:
|
||||
|
||||
<ReadMore list />
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
title: Permanent ban
|
||||
order: 40
|
||||
---
|
||||
|
||||
##### Community Impact
|
||||
Demonstrating a pattern of violation of
|
||||
community standards, including sustained inappropriate behavior,
|
||||
harassment of an individual, or aggression toward or
|
||||
disparagement of classes of individuals.
|
||||
|
||||
##### Consequence
|
||||
A permanent ban from any sort of public interaction within the community.
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: Temporary ban
|
||||
order: 30
|
||||
---
|
||||
|
||||
##### Community Impact
|
||||
A serious violation of community standards,
|
||||
including sustained inappropriate behavior.
|
||||
|
||||
##### Consequence
|
||||
A temporary ban from any sort of interaction or
|
||||
public communication with the community for a specified period
|
||||
of time.
|
||||
|
||||
No public or private interaction with the people
|
||||
involved, including unsolicited interaction with those enforcing
|
||||
the Code of Conduct, is allowed during this period.
|
||||
|
||||
Violating these terms may lead to a permanent ban.
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
---
|
||||
title: Warning
|
||||
order: 20
|
||||
---
|
||||
|
||||
##### Community Impact
|
||||
A violation through a single incident or series of actions.
|
||||
|
||||
##### Consequence
|
||||
A warning with consequences for continued behavior.
|
||||
No interaction with the people involved, including unsolicited
|
||||
interaction with those enforcing the Code of Conduct, for a
|
||||
specified period of time. This includes avoiding interactions
|
||||
in community spaces as well as external channels like social
|
||||
media.
|
||||
|
||||
Violating these terms may lead to a temporary or permanent ban.
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
title: Enforcement responsibilities
|
||||
order: 30
|
||||
---
|
||||
|
||||
Community leaders are responsible for clarifying and enforcing our standards
|
||||
of acceptable behavior and will take appropriate and fair corrective action
|
||||
in response to any behavior that they deem inappropriate, threatening,
|
||||
offensive, or harmful.
|
||||
|
||||
Community leaders have the right and responsibility to remove, edit, or
|
||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||
that are not aligned to this Code of Conduct, and will communicate reasons
|
||||
for moderation decisions when appropriate.
|
16
markdown/dev/contributors/code-of-conduct/enforcement/en.md
Normal file
16
markdown/dev/contributors/code-of-conduct/enforcement/en.md
Normal file
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
title: Enforcement
|
||||
order: 50
|
||||
---
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior
|
||||
may be reported to the community leaders responsible for enforcement:
|
||||
|
||||
- Joost De Cock (joost@joost.at)
|
||||
- Sorcha Ní Dhubhghaill (nidhubhs@gmail.com)
|
||||
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and
|
||||
security of the reporter of any incident.
|
||||
|
16
markdown/dev/contributors/code-of-conduct/our-pledge/en.md
Normal file
16
markdown/dev/contributors/code-of-conduct/our-pledge/en.md
Normal file
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
title: Our pledge
|
||||
order: 10
|
||||
---
|
||||
|
||||
We as members, contributors, and leaders of the FreeSewing community pledge
|
||||
to make participation in our community a harassment-free experience for everyone.
|
||||
|
||||
Everyone, regardless of age, body size, visible or invisible disability,
|
||||
ethnicity, sex characteristics, gender identity and expression, level of experience,
|
||||
education, socio-economic status, nationality, personal appearance, race,
|
||||
religion, or sexual identity and orientation.
|
||||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||
diverse, inclusive, and healthy community.
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: Our standards
|
||||
order: 20
|
||||
---
|
||||
|
||||
Examples of behavior that contributes to a positive environment for our community include:
|
||||
|
||||
- Demonstrating empathy and kindness toward other people
|
||||
- Being respectful of differing opinions, viewpoints, and experiences
|
||||
- Giving and gracefully accepting constructive feedback
|
||||
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
|
||||
- Focusing on what is best not just for us as individuals, but for the overall community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
- The use of sexualized language or imagery, and sexual attention or advances of any kind
|
||||
- Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
- Public or private harassment
|
||||
- Publishing others’ private information, such as a physical or email address, without their explicit permission
|
||||
- Other conduct which could reasonably be considered inappropriate in a professional setting
|
12
markdown/dev/contributors/code-of-conduct/scope/en.md
Normal file
12
markdown/dev/contributors/code-of-conduct/scope/en.md
Normal file
|
@ -0,0 +1,12 @@
|
|||
---
|
||||
title: Scope
|
||||
order: 40
|
||||
---
|
||||
|
||||
This Code of Conduct applies within all FreeSewing community spaces, and also applies
|
||||
when an individual is officially representing the FreeSewing community in public spaces.
|
||||
|
||||
Examples of representing our community include using an official e-mail address,
|
||||
posting via an official social media account, or acting as an appointed representative
|
||||
at an online or offline event.
|
||||
|
66
markdown/dev/contributors/de.md
Normal file
66
markdown/dev/contributors/de.md
Normal file
|
@ -0,0 +1,66 @@
|
|||
---
|
||||
title: Documentation for contributors
|
||||
---
|
||||
|
||||
Are you interested in contributing to freesewing? That's awesome, and exactly why this thing is open source in the first place.
|
||||
|
||||
## Code of conduct
|
||||
|
||||
Freesewing strives to be an open and inclusive community. To keep the trolls at bay, we have a [code of conduct](/guides/code-of-conduct/). As a contributor, you are expected to uphold it.
|
||||
|
||||
## Where to get help or report a problem
|
||||
|
||||
- The [freesewing chat room on Gitter](https://gitter.im/freesewing/help) is the best place to ask questions, meet other freesewers, or just hang out and share a laugh.
|
||||
- Chat not your thing? The [@freesewing_org](https://twitter.com/freesewing_org) Twitter account is the next best thing.
|
||||
- Haben Sie einen Fehler festgestellt? Have a suggestion for an improvement? Please [file an issue on GitHub](https://github.com/freesewing/freesewing/issues/new). Dafür benötigen Sie einen GitHub-Account, diesen können Sie kostenlos erstellen.
|
||||
|
||||
## Ways to contribute
|
||||
|
||||
There's may ways to contribute to freesewing. Here are some of the more common ones, from easy to more involved:
|
||||
|
||||
### Help spread the word
|
||||
|
||||
Tell your friends about freesewing, or spread awareness on social media. If you have a blog, perhaps you can write about us, or review one of our patterns.
|
||||
|
||||
It may seem simple, but it's probably how you heard about us in the first place. So pay it forward.
|
||||
|
||||
### Improve our content
|
||||
|
||||
On every page, there's a link at the bottom that allows you to submit improvements. You'll need a GitHub account for this, but they are free.
|
||||
|
||||
Use that button. Don't be shy. If you see a typo, or something that needs clarification or more detail, please suggest your improvements.
|
||||
|
||||
|
||||
### Help with translation
|
||||
|
||||
Translation is one of the most important aspects to bring FreeSewing to all corners of the world. It's also something for which we are completely dependent on the community.
|
||||
|
||||
Our [documentation for translators](/guides/translator/) will tell you all you need to know to get started.
|
||||
|
||||
### Test, make, or showcase our patterns
|
||||
|
||||
Are you a maker? Go ahead and make [our patterns](https://freesewing.org/patterns), share your experience, and provide us your feedback.
|
||||
|
||||
We'd love to get pictures to [showcase](https://freesewing.org/showcase) on our website too.
|
||||
|
||||
### Design patterns
|
||||
|
||||
Desiging more FreeSewing patterns is a great way to help out.
|
||||
|
||||
You can [take the tutorial](/tutorials/pattern-design/) and jump right in. Or, join [our chat room on Gitter](https://gitter.im/freesewing/development) to discuss ideas, or find designers or developers to team up with.
|
||||
|
||||
### Contribute to our code
|
||||
|
||||
Interested in submitting a pull request for our code? Awesome. All [our repositories](/reference/repos/) are available [on GitHub](https://github.com/freesewing).
|
||||
|
||||
Our [chat room on Gitter](https://gitter.im/freesewing/development) is the best place to discuss ideas or ask questions.
|
||||
|
||||
### Become a patron
|
||||
|
||||
All our patterns, and all our code, is accessible to everyone, regardless of where they live or what they can afford.
|
||||
|
||||
This is made possible by our Patrons; Loyal supporters who ensure a sustainable future for freesewing.org, our code, our patterns, and our community.
|
||||
|
||||
You can [become a Patron for as little as 2€ per month](https://freesewing.org/patrons/join). It's a very tangible way to support the project.
|
||||
|
||||
|
36
markdown/dev/contributors/en.md
Normal file
36
markdown/dev/contributors/en.md
Normal file
|
@ -0,0 +1,36 @@
|
|||
---
|
||||
title: For contributors
|
||||
order: 1110
|
||||
---
|
||||
|
||||
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:
|
||||
|
||||
<Note>
|
||||
|
||||
##### Contributor requirements
|
||||
|
||||
- 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/)
|
||||
|
||||
</Note>
|
||||
|
||||
With that out of the way, here's a few more things that are *good to know*:
|
||||
|
||||
<Tip>
|
||||
|
||||
##### 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 --
|
||||
See our [revenue pledge](https://freesewing.org/docs/various/pledge/) for details
|
||||
|
||||
</Tip>
|
||||
|
||||
|
||||
With the formalities out of the way, please continue
|
||||
to [Ways to contribute](/contributors/ways-to-contribute)
|
||||
or [Where to get help](/contributors/help/).
|
||||
|
66
markdown/dev/contributors/es.md
Normal file
66
markdown/dev/contributors/es.md
Normal file
|
@ -0,0 +1,66 @@
|
|||
---
|
||||
title: Documentation for contributors
|
||||
---
|
||||
|
||||
Are you interested in contributing to freesewing? That's awesome, and exactly why this thing is open source in the first place.
|
||||
|
||||
## Code of conduct
|
||||
|
||||
Freesewing strives to be an open and inclusive community. To keep the trolls at bay, we have a [code of conduct](/guides/code-of-conduct/). As a contributor, you are expected to uphold it.
|
||||
|
||||
## Where to get help or report a problem
|
||||
|
||||
- The [freesewing chat room on Gitter](https://gitter.im/freesewing/help) is the best place to ask questions, meet other freesewers, or just hang out and share a laugh.
|
||||
- Chat not your thing? The [@freesewing_org](https://twitter.com/freesewing_org) Twitter account is the next best thing.
|
||||
- Did you spot a mistake? Have a suggestion for an improvement? Please [file an issue on GitHub](https://github.com/freesewing/freesewing/issues/new). You'll need a GitHub account, but they are free.
|
||||
|
||||
## Ways to contribute
|
||||
|
||||
There's may ways to contribute to freesewing. Here are some of the more common ones, from easy to more involved:
|
||||
|
||||
### Help spread the word
|
||||
|
||||
Tell your friends about freesewing, or spread awareness on social media. If you have a blog, perhaps you can write about us, or review one of our patterns.
|
||||
|
||||
It may seem simple, but it's probably how you heard about us in the first place. So pay it forward.
|
||||
|
||||
### Improve our content
|
||||
|
||||
On every page, there's a link at the bottom that allows you to submit improvements. You'll need a GitHub account for this, but they are free.
|
||||
|
||||
Use that button. Don't be shy. If you see a typo, or something that needs clarification or more detail, please suggest your improvements.
|
||||
|
||||
|
||||
### Help with translation
|
||||
|
||||
Translation is one of the most important aspects to bring FreeSewing to all corners of the world. It's also something for which we are completely dependent on the community.
|
||||
|
||||
Our [documentation for translators](/guides/translator/) will tell you all you need to know to get started.
|
||||
|
||||
### Test, make, or showcase our patterns
|
||||
|
||||
Are you a maker? Go ahead and make [our patterns](https://freesewing.org/patterns), share your experience, and provide us your feedback.
|
||||
|
||||
We'd love to get pictures to [showcase](https://freesewing.org/showcase) on our website too.
|
||||
|
||||
### Design patterns
|
||||
|
||||
Desiging more FreeSewing patterns is a great way to help out.
|
||||
|
||||
You can [take the tutorial](/tutorials/pattern-design/) and jump right in. Or, join [our chat room on Gitter](https://gitter.im/freesewing/development) to discuss ideas, or find designers or developers to team up with.
|
||||
|
||||
### Contribute to our code
|
||||
|
||||
Interested in submitting a pull request for our code? Awesome. All [our repositories](/reference/repos/) are available [on GitHub](https://github.com/freesewing).
|
||||
|
||||
Our [chat room on Gitter](https://gitter.im/freesewing/development) is the best place to discuss ideas or ask questions.
|
||||
|
||||
### Become a patron
|
||||
|
||||
All our patterns, and all our code, is accessible to everyone, regardless of where they live or what they can afford.
|
||||
|
||||
This is made possible by our Patrons; Loyal supporters who ensure a sustainable future for freesewing.org, our code, our patterns, and our community.
|
||||
|
||||
You can [become a Patron for as little as 2€ per month](https://freesewing.org/patrons/join). It's a very tangible way to support the project.
|
||||
|
||||
|
66
markdown/dev/contributors/fr.md
Normal file
66
markdown/dev/contributors/fr.md
Normal file
|
@ -0,0 +1,66 @@
|
|||
---
|
||||
title: Documentation for contributors
|
||||
---
|
||||
|
||||
Are you interested in contributing to freesewing? That's awesome, and exactly why this thing is open source in the first place.
|
||||
|
||||
## Code of conduct
|
||||
|
||||
Freesewing strives to be an open and inclusive community. To keep the trolls at bay, we have a [code of conduct](/guides/code-of-conduct/). As a contributor, you are expected to uphold it.
|
||||
|
||||
## Where to get help or report a problem
|
||||
|
||||
- The [freesewing chat room on Gitter](https://gitter.im/freesewing/help) is the best place to ask questions, meet other freesewers, or just hang out and share a laugh.
|
||||
- Chat not your thing? The [@freesewing_org](https://twitter.com/freesewing_org) Twitter account is the next best thing.
|
||||
- Avez-vous trouvé une erreur ? Have a suggestion for an improvement? Please [file an issue on GitHub](https://github.com/freesewing/freesewing/issues/new). Vous aurez besoin d'un compte GitHub, mais ils sont gratuits.
|
||||
|
||||
## Ways to contribute
|
||||
|
||||
There's may ways to contribute to freesewing. Here are some of the more common ones, from easy to more involved:
|
||||
|
||||
### Help spread the word
|
||||
|
||||
Tell your friends about freesewing, or spread awareness on social media. If you have a blog, perhaps you can write about us, or review one of our patterns.
|
||||
|
||||
It may seem simple, but it's probably how you heard about us in the first place. So pay it forward.
|
||||
|
||||
### Improve our content
|
||||
|
||||
On every page, there's a link at the bottom that allows you to submit improvements. You'll need a GitHub account for this, but they are free.
|
||||
|
||||
Use that button. Don't be shy. If you see a typo, or something that needs clarification or more detail, please suggest your improvements.
|
||||
|
||||
|
||||
### Help with translation
|
||||
|
||||
Translation is one of the most important aspects to bring FreeSewing to all corners of the world. It's also something for which we are completely dependent on the community.
|
||||
|
||||
Our [documentation for translators](/guides/translator/) will tell you all you need to know to get started.
|
||||
|
||||
### Test, make, or showcase our patterns
|
||||
|
||||
Are you a maker? Go ahead and make [our patterns](https://freesewing.org/patterns), share your experience, and provide us your feedback.
|
||||
|
||||
We'd love to get pictures to [showcase](https://freesewing.org/showcase) on our website too.
|
||||
|
||||
### Design patterns
|
||||
|
||||
Desiging more FreeSewing patterns is a great way to help out.
|
||||
|
||||
You can [take the tutorial](/tutorials/pattern-design/) and jump right in. Or, join [our chat room on Gitter](https://gitter.im/freesewing/development) to discuss ideas, or find designers or developers to team up with.
|
||||
|
||||
### Contribute to our code
|
||||
|
||||
Interested in submitting a pull request for our code? Awesome. All [our repositories](/reference/repos/) are available [on GitHub](https://github.com/freesewing).
|
||||
|
||||
Our [chat room on Gitter](https://gitter.im/freesewing/development) is the best place to discuss ideas or ask questions.
|
||||
|
||||
### Become a patron
|
||||
|
||||
All our patterns, and all our code, is accessible to everyone, regardless of where they live or what they can afford.
|
||||
|
||||
This is made possible by our Patrons; Loyal supporters who ensure a sustainable future for freesewing.org, our code, our patterns, and our community.
|
||||
|
||||
You can [become a Patron for as little as 2€ per month](https://freesewing.org/patrons/join). It's a very tangible way to support the project.
|
||||
|
||||
|
26
markdown/dev/contributors/help/en.md
Normal file
26
markdown/dev/contributors/help/en.md
Normal file
|
@ -0,0 +1,26 @@
|
|||
---
|
||||
title: Where to get help
|
||||
for: contributors
|
||||
icons:
|
||||
- help
|
||||
- discord
|
||||
about: |
|
||||
Our [chatrooms on Discord](https://discord.freesewing.org/) are the best place to
|
||||
ask questions or share your feedback
|
||||
---
|
||||
|
||||
Our [chatrooms on Discord](https://discord.freesewing.org/) are the best place to
|
||||
ask questions or share your feedback.
|
||||
|
||||
Many of the FreeSewing contributors hang out there, and since we're spread over
|
||||
different parts of the world, you're likely to find somebody there who can answer
|
||||
your question(s) at any given moment.
|
||||
|
||||
|
||||
<Tip>
|
||||
|
||||
If you want to report a problem, please [create an issue](https://github.com/freesewing/freesewing/issues/new).
|
||||
|
||||
</Tip>
|
||||
|
||||
|
66
markdown/dev/contributors/nl.md
Normal file
66
markdown/dev/contributors/nl.md
Normal file
|
@ -0,0 +1,66 @@
|
|||
---
|
||||
title: Documentation for contributors
|
||||
---
|
||||
|
||||
Are you interested in contributing to freesewing? That's awesome, and exactly why this thing is open source in the first place.
|
||||
|
||||
## Code of conduct
|
||||
|
||||
Freesewing strives to be an open and inclusive community. To keep the trolls at bay, we have a [code of conduct](/guides/code-of-conduct/). As a contributor, you are expected to uphold it.
|
||||
|
||||
## Where to get help or report a problem
|
||||
|
||||
- The [freesewing chat room on Gitter](https://gitter.im/freesewing/help) is the best place to ask questions, meet other freesewers, or just hang out and share a laugh.
|
||||
- Chat not your thing? The [@freesewing_org](https://twitter.com/freesewing_org) Twitter account is the next best thing.
|
||||
- Foutje gevonden? Have a suggestion for an improvement? Please [file an issue on GitHub](https://github.com/freesewing/freesewing/issues/new). Je hebt een Github accout nodig, maar die zijn gratis.
|
||||
|
||||
## Ways to contribute
|
||||
|
||||
There's may ways to contribute to freesewing. Here are some of the more common ones, from easy to more involved:
|
||||
|
||||
### Help spread the word
|
||||
|
||||
Tell your friends about freesewing, or spread awareness on social media. If you have a blog, perhaps you can write about us, or review one of our patterns.
|
||||
|
||||
It may seem simple, but it's probably how you heard about us in the first place. So pay it forward.
|
||||
|
||||
### Improve our content
|
||||
|
||||
On every page, there's a link at the bottom that allows you to submit improvements. You'll need a GitHub account for this, but they are free.
|
||||
|
||||
Use that button. Don't be shy. If you see a typo, or something that needs clarification or more detail, please suggest your improvements.
|
||||
|
||||
|
||||
### Help with translation
|
||||
|
||||
Translation is one of the most important aspects to bring FreeSewing to all corners of the world. It's also something for which we are completely dependent on the community.
|
||||
|
||||
Our [documentation for translators](/guides/translator/) will tell you all you need to know to get started.
|
||||
|
||||
### Test, make, or showcase our patterns
|
||||
|
||||
Are you a maker? Go ahead and make [our patterns](https://freesewing.org/patterns), share your experience, and provide us your feedback.
|
||||
|
||||
We'd love to get pictures to [showcase](https://freesewing.org/showcase) on our website too.
|
||||
|
||||
### Design patterns
|
||||
|
||||
Desiging more FreeSewing patterns is a great way to help out.
|
||||
|
||||
You can [take the tutorial](/tutorials/pattern-design/) and jump right in. Or, join [our chat room on Gitter](https://gitter.im/freesewing/development) to discuss ideas, or find designers or developers to team up with.
|
||||
|
||||
### Contribute to our code
|
||||
|
||||
Interested in submitting a pull request for our code? Awesome. All [our repositories](/reference/repos/) are available [on GitHub](https://github.com/freesewing).
|
||||
|
||||
Our [chat room on Gitter](https://gitter.im/freesewing/development) is the best place to discuss ideas or ask questions.
|
||||
|
||||
### Become a patron
|
||||
|
||||
All our patterns, and all our code, is accessible to everyone, regardless of where they live or what they can afford.
|
||||
|
||||
This is made possible by our Patrons; Loyal supporters who ensure a sustainable future for freesewing.org, our code, our patterns, and our community.
|
||||
|
||||
You can [become a Patron for as little as 2€ per month](https://freesewing.org/patrons/join). It's a very tangible way to support the project.
|
||||
|
||||
|
5
markdown/dev/contributors/terms/backend/en.md
Normal file
5
markdown/dev/contributors/terms/backend/en.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Backend
|
||||
---
|
||||
|
||||
[The FreeSewing backend](https://backend.freesewing.org/) handles all user data for freesewing.org.
|
7
markdown/dev/contributors/terms/commit/en.md
Normal file
7
markdown/dev/contributors/terms/commit/en.md
Normal file
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: Commit
|
||||
---
|
||||
|
||||
A [commit](https://github.com/git-guides/git-commit) is made every time somebody published an update to our source code.
|
||||
|
||||
The words is also used as a verb as in _to commit changes_.
|
8
markdown/dev/contributors/terms/contributor-call/en.md
Normal file
8
markdown/dev/contributors/terms/contributor-call/en.md
Normal file
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: Contributor call (fscc)
|
||||
---
|
||||
|
||||
The FreeSewing Contributor Call (fscc) is a
|
||||
bi-weekly conference call/zoom meeting with the FreeSewing contributors.
|
||||
|
||||
Anybody is free to join, and the calls take place at https://meet.freesewing.org
|
8
markdown/dev/contributors/terms/contributor/en.md
Normal file
8
markdown/dev/contributors/terms/contributor/en.md
Normal file
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: Contributor
|
||||
---
|
||||
|
||||
Anybody who contributes to FreeSewing in a material way. Either with code contributions,
|
||||
or community building, or pattern design, and so on.
|
||||
|
||||
The [list of contributors](https://freesewing.org/community/who/) is available on freesewing.org.
|
11
markdown/dev/contributors/terms/design-pattern/en.md
Normal file
11
markdown/dev/contributors/terms/design-pattern/en.md
Normal file
|
@ -0,0 +1,11 @@
|
|||
---
|
||||
title: Design/Pattern
|
||||
---
|
||||
|
||||
The terms **pattern** and **design** somewhat overlap and their exact meaning
|
||||
depends on the context.
|
||||
|
||||
A **design** is a software package that implements a given design on top of our core library.
|
||||
Simon is a design, Teagan is a design, and so is Sandy.
|
||||
|
||||
A **pattern** is an instance of a design. A design that's made-to-measure for a user.
|
5
markdown/dev/contributors/terms/developer/en.md
Normal file
5
markdown/dev/contributors/terms/developer/en.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Developer
|
||||
---
|
||||
|
||||
Anybody who works with software code or wants to learn to do so.
|
7
markdown/dev/contributors/terms/discord/en.md
Normal file
7
markdown/dev/contributors/terms/discord/en.md
Normal file
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: Discord
|
||||
---
|
||||
|
||||
The name of our chat provider that powers our chat at https://discord.freesewing.org/
|
||||
|
||||
When you hear _discord_ just think _chat_.
|
6
markdown/dev/contributors/terms/editor/en.md
Normal file
6
markdown/dev/contributors/terms/editor/en.md
Normal file
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Editor
|
||||
---
|
||||
|
||||
A person who contributs to/with content. Either by writing blog posts or documentation,
|
||||
or posts for social media. But it can also be video editing or making illustrations.
|
13
markdown/dev/contributors/terms/en.md
Normal file
13
markdown/dev/contributors/terms/en.md
Normal file
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
title: Terminology
|
||||
icons:
|
||||
- logo
|
||||
- terms
|
||||
for: contributors
|
||||
about: Terms and definitions that will help you navigate the world of FreeSewing
|
||||
---
|
||||
|
||||
Below is a list of terms you may come across when working with FreeSewing with a
|
||||
link to a brief description:
|
||||
|
||||
<ReadMore list />
|
7
markdown/dev/contributors/terms/express/en.md
Normal file
7
markdown/dev/contributors/terms/express/en.md
Normal file
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: Express
|
||||
---
|
||||
|
||||
[Express](https://expressjs.com/) is a web framework for NodeJS.
|
||||
|
||||
The FreeSewing backend is powered by Express.
|
5
markdown/dev/contributors/terms/freesewing.dev/en.md
Normal file
5
markdown/dev/contributors/terms/freesewing.dev/en.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: freesewing.dev
|
||||
---
|
||||
|
||||
Our website for developers.
|
107
markdown/dev/contributors/terms/freesewing.org/en.md
Normal file
107
markdown/dev/contributors/terms/freesewing.org/en.md
Normal file
|
@ -0,0 +1,107 @@
|
|||
---
|
||||
title: freesewing.org
|
||||
---
|
||||
|
||||
Our website for makers.
|
||||
|
||||
## FreeSewing.dev
|
||||
|
||||
Our website for developers.
|
||||
|
||||
## Frontend
|
||||
|
||||
A user-facing interface. Can refer to one of our websites, or our development environment.
|
||||
|
||||
## Gatsby
|
||||
|
||||
A static-site generator using React. Both freesewing.org and freesewing.dev are
|
||||
built with Gatsby.
|
||||
|
||||
## i18n
|
||||
|
||||
Short of _internationalisation_. within the context of FreeSewing, this mostly
|
||||
means translation, but can also relate to other intenationalisation concerns such
|
||||
as the type of units to use, or paper sizes, and so on.
|
||||
|
||||
## Issue
|
||||
|
||||
An issue is a sort of support ticket. It can be a bug report, a feature request, a question
|
||||
or problem report.
|
||||
|
||||
Issues are hosted on Github. Each repository can have its own issues, but most our
|
||||
issue are handled on our monorepo: https://github.com/freesewing/freesewing/issues b
|
||||
|
||||
## Javascript
|
||||
|
||||
The programming language in which FreeSewing is written. It can run in your
|
||||
browser, as well as outside of it with Node JS.
|
||||
|
||||
## Made-to-measure
|
||||
|
||||
Made to someone's (body) measurements, rather than based on specific sizes.
|
||||
|
||||
## Markdown
|
||||
|
||||
A plain text markup format that is easy to read for computers and humans alike.
|
||||
It's a way to write things in plain text, yet make them look pretty in HTML.
|
||||
|
||||
All our content is written in markdown. Github issues, commit messages, and comments
|
||||
also all support markdown.
|
||||
|
||||
## Monorepo
|
||||
|
||||
A monorepo is an organisational approach to software development where rather than
|
||||
having a multitude of repositories, a number of different software pieces are bundled
|
||||
together in a single repository.
|
||||
|
||||
FreeSewing's monorepo holds all our Javascript packages in such a structure.
|
||||
|
||||
## Node
|
||||
|
||||
Node (or Node JS) is a Javascript runtime that allows to use the language outside the browser.
|
||||
|
||||
## Parametric pattern design
|
||||
|
||||
A design approach whereby sewing patterns are contructed based on parameters,
|
||||
and can adapt automatically when those parameters change.
|
||||
|
||||
Those parameters almost always include body measurements, and user preferences.
|
||||
|
||||
## Patron
|
||||
|
||||
A person who supports FreeSewing financially.
|
||||
|
||||
## Plugin
|
||||
|
||||
An extension to FreeSewing core that provides an extra feature of functionality.
|
||||
|
||||
## Pull request
|
||||
|
||||
A pull request is a proposal to commit changes to a repository.
|
||||
|
||||
Pull requests can either be made because the person does not have the rights to make
|
||||
changes to the repository directly. Or to discuss or validate the changes prior to
|
||||
accepting them.
|
||||
|
||||
## React
|
||||
|
||||
A Javascript framework to build user interfaces on the web.
|
||||
|
||||
All our frontends are build with React.
|
||||
|
||||
## Repository
|
||||
|
||||
We develop our software collaboratively, and all code is available in Github in so-called repositories.
|
||||
|
||||
One repository bundles a bunch of things that belong together. Think of it as a project.
|
||||
|
||||
## Tiler
|
||||
|
||||
The FreeSewing tiler is responsible for taking a pattern and splitting it into different
|
||||
pages so it can be printed.
|
||||
|
||||
The tiler is a backend service that is independent from the main FreeSewing backend.
|
||||
|
||||
## Translator
|
||||
|
||||
Somebody who helps with our i18n efforts by translating from Enlish to other languages.
|
5
markdown/dev/contributors/terms/freesewing/en.md
Normal file
5
markdown/dev/contributors/terms/freesewing/en.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: FreeSewing
|
||||
---
|
||||
|
||||
FreeSewing refers to the community-driven open source project.
|
5
markdown/dev/contributors/terms/frontend/en.md
Normal file
5
markdown/dev/contributors/terms/frontend/en.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Frontend
|
||||
---
|
||||
|
||||
A user-facing interface. Can refer to one of our websites, or our development environment.
|
7
markdown/dev/contributors/terms/gatsby/en.md
Normal file
7
markdown/dev/contributors/terms/gatsby/en.md
Normal file
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: Gatsby
|
||||
---
|
||||
|
||||
[Gatsby](https://www.gatsbyjs.com/) is a static-site generator for React.
|
||||
|
||||
Both freesewing.org and freesewing.dev are built on top of Gatsby.
|
7
markdown/dev/contributors/terms/i18n/en.md
Normal file
7
markdown/dev/contributors/terms/i18n/en.md
Normal file
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: i18n
|
||||
---
|
||||
|
||||
Short for _internationalisation_. Within the context of FreeSewing, this mostly
|
||||
means translation, but can also relate to other internationalisation concerns such
|
||||
as the type of units to use, or paper sizes, and so on.
|
9
markdown/dev/contributors/terms/issue/en.md
Normal file
9
markdown/dev/contributors/terms/issue/en.md
Normal file
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: Issue
|
||||
---
|
||||
|
||||
An issue is a sort of support ticket. It can be a bug report, a feature request, a question
|
||||
or problem report.
|
||||
|
||||
Issues are hosted on Github. Each repository can have its own issues, but most our
|
||||
issue are handled on our monorepo: https://github.com/freesewing/freesewing/issues
|
6
markdown/dev/contributors/terms/javascript/en.md
Normal file
6
markdown/dev/contributors/terms/javascript/en.md
Normal file
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Javascript
|
||||
---
|
||||
|
||||
The programming language in which FreeSewing is written. It can run in your
|
||||
browser, as well as outside of it with Node JS.
|
5
markdown/dev/contributors/terms/made-to-measure/en.md
Normal file
5
markdown/dev/contributors/terms/made-to-measure/en.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Made-to-measure
|
||||
---
|
||||
|
||||
Made to someone's (body) measurements, rather than based on specific sizes.
|
9
markdown/dev/contributors/terms/markdown/en.md
Normal file
9
markdown/dev/contributors/terms/markdown/en.md
Normal file
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: Markdown
|
||||
---
|
||||
|
||||
A plain text markup format that is easy to read for computers and humans alike.
|
||||
It's a way to write things in plain text, yet make them look pretty in HTML.
|
||||
|
||||
All our content is written in markdown. Github issues, commit messages, and comments
|
||||
also all support markdown.
|
9
markdown/dev/contributors/terms/monorepo/en.md
Normal file
9
markdown/dev/contributors/terms/monorepo/en.md
Normal file
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: Monorepo
|
||||
---
|
||||
|
||||
A monorepo is an organisational approach to software development where rather than
|
||||
having a multitude of repositories, a number of different software pieces are bundled
|
||||
together in a single repository.
|
||||
|
||||
FreeSewing's monorepo holds all our Javascript packages in such a structure.
|
5
markdown/dev/contributors/terms/node/en.md
Normal file
5
markdown/dev/contributors/terms/node/en.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Node
|
||||
---
|
||||
|
||||
Node (or NodeJS) is a Javascript runtime that allows to use the language outside the browser.
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: Parametric pattern design
|
||||
---
|
||||
|
||||
A design approach whereby sewing patterns are contructed based on parameters,
|
||||
and can adapt automatically when those parameters change.
|
||||
|
||||
Those parameters almost always include body measurements, and user preferences.
|
5
markdown/dev/contributors/terms/patron/en.md
Normal file
5
markdown/dev/contributors/terms/patron/en.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Patron
|
||||
---
|
||||
|
||||
A person who supports FreeSewing financially.
|
5
markdown/dev/contributors/terms/plugin/en.md
Normal file
5
markdown/dev/contributors/terms/plugin/en.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Plugin
|
||||
---
|
||||
|
||||
An extension to FreeSewing core that provides an extra feature of functionality.
|
9
markdown/dev/contributors/terms/pull-request/en.md
Normal file
9
markdown/dev/contributors/terms/pull-request/en.md
Normal file
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: Pull request
|
||||
---
|
||||
|
||||
A pull request is a proposal to commit changes to a repository.
|
||||
|
||||
Pull requests can either be made because the person does not have the rights to make
|
||||
changes to the repository directly. Or to discuss or validate the changes prior to
|
||||
accepting them.
|
7
markdown/dev/contributors/terms/react/en.md
Normal file
7
markdown/dev/contributors/terms/react/en.md
Normal file
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: React
|
||||
---
|
||||
|
||||
[React](https://reactjs.org/) is a Javascript framework to build user interfaces on the web.
|
||||
|
||||
All our frontends are built with React.
|
5
markdown/dev/contributors/terms/repo/en.md
Normal file
5
markdown/dev/contributors/terms/repo/en.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Repo
|
||||
---
|
||||
|
||||
Short for [repository](/contributors/terms/repository/).
|
7
markdown/dev/contributors/terms/repository/en.md
Normal file
7
markdown/dev/contributors/terms/repository/en.md
Normal file
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: Repository
|
||||
---
|
||||
|
||||
We develop our software collaboratively, and all code is available in Github in so-called repositories.
|
||||
|
||||
One repository bundles a bunch of things that belong together. Think of it as a project.
|
9
markdown/dev/contributors/terms/tiler/en.md
Normal file
9
markdown/dev/contributors/terms/tiler/en.md
Normal file
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: Tiler
|
||||
---
|
||||
|
||||
The FreeSewing tiler is responsible for taking a pattern and splitting it into different
|
||||
pages so it can be printed.
|
||||
|
||||
The tiler is a backend service that is independent from the main FreeSewing backend.
|
||||
|
5
markdown/dev/contributors/terms/translator/en.md
Normal file
5
markdown/dev/contributors/terms/translator/en.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Translator
|
||||
---
|
||||
|
||||
Somebody who helps with our i18n efforts by translating from English to other languages.
|
|
@ -0,0 +1,11 @@
|
|||
---
|
||||
title: Body ambassador
|
||||
---
|
||||
|
||||
Maybe you’re unusually short or tall.
|
||||
Maybe you have a bit of a pot belly or very large breasts.
|
||||
Maybe you have a disability that requires fit adjustments.
|
||||
|
||||
Whatever it is, if you represent a minority fitting issue you could
|
||||
represent this minority to make sure their needs are heard and understood.
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
---
|
||||
title: Community building
|
||||
---
|
||||
|
||||
The FreeSewing community resides [on Discord](https://discord.freesewing.org/).
|
||||
Just being there to answer questions and chat with other people is a valuable part of community building.
|
||||
|
||||
We also can be found [in plenty of other places](https://freesewing.org/community/where/) where we'd love to have you join us.
|
||||
|
||||
Apart from being present in chat rooms and social media, you could also take on some responsibility on one or more platforms.
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: Design sewing patterns
|
||||
---
|
||||
|
||||
Everybody wants us to add more patterns. But somebody has to design them.
|
||||
|
||||
That somebody could be you.
|
||||
We can help you with the development side of things.
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: Develop sewing patterns
|
||||
---
|
||||
|
||||
You could program new designs for FreeSewing.
|
||||
If you're not afraid of Javascript and are happy to team up with a designer,
|
||||
you could work on a new pattern together.
|
||||
|
10
markdown/dev/contributors/ways-to-contribute/devops/en.md
Normal file
10
markdown/dev/contributors/ways-to-contribute/devops/en.md
Normal file
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
title: Devops
|
||||
---
|
||||
|
||||
We have use a lot of automation from Github actions to automated deployment on Netlify.
|
||||
We also have some Ansible playbooks to run maintenance tasks.
|
||||
|
||||
There's also other technical tasks like database or server administration, certificate renewal, and so on.
|
||||
|
||||
If that's your kind of thing, we could use your help.
|
37
markdown/dev/contributors/ways-to-contribute/en.md
Normal file
37
markdown/dev/contributors/ways-to-contribute/en.md
Normal file
|
@ -0,0 +1,37 @@
|
|||
---
|
||||
title: Ways to contribute
|
||||
---
|
||||
|
||||
<Tip>
|
||||
|
||||
##### 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/).
|
||||
|
||||
</Tip>
|
||||
|
||||
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:
|
||||
|
||||
<ReadMore list />
|
||||
|
||||
<Note>
|
||||
|
||||
##### 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.
|
||||
|
||||
</Note>
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: Make illustrations
|
||||
---
|
||||
|
||||
Our documentation can always use some more/better illustrations to help people figure out how
|
||||
to make our patterns into garments.
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: Language ambassador
|
||||
---
|
||||
|
||||
You could represent FreeSewing in a non-English community.
|
||||
There, you can help answer questions or triage problem reports.
|
||||
Or you can point out where translations are missing.
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: Pattern amabassador
|
||||
---
|
||||
|
||||
You could take charge of a specific FreeSewing design/pattern.
|
||||
|
||||
You’ll be the person to ask questions about how to make that pattern.
|
||||
You’ll make sure the documentation is not forgotten.
|
||||
And you can help with questions or triage problem reports to developers or designers.
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Pattern testing
|
||||
---
|
||||
|
||||
You could make (a muslin for) our patterns prior to release to make sure everything is ok.
|
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
title: Project management
|
||||
---
|
||||
|
||||
There's a lot going on within the FreeSewing project and it's easy to forget about something.
|
||||
|
||||
A project manager would be helpful to prioritize tasks, makes sure all tasks have an issue,
|
||||
organize milestones, and so on.
|
||||
|
||||
This is helpful in more than one way:
|
||||
|
||||
- It reduces the cognitive load of the people implementing changes because they don't have to worry about forgetting things
|
||||
- It increases transparency by making it clear what sort of things are being worked on
|
||||
- It gives us that good feeling of closing the issue when the task is done
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Proofreading
|
||||
---
|
||||
|
||||
You could check the original English text of translations for typos and/or grammar mistakes.
|
||||
You could propose improvements and watch over a consistent style and tone across FreeSewing’s documentation and written text.
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
title: Report bugs
|
||||
---
|
||||
|
||||
Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/).
|
||||
Create an issue [in our monorepo](https://github.com/freesewing/freesewing/issues/new?assignees=&labels=%F0%9F%90%9B+bug&template=bug-report.md&title=Bug+report) if you've found one.
|
||||
|
||||
Explain the problem and include additional details to help maintainers reproduce the problem:
|
||||
|
||||
* **Use a clear and descriptive title** for the issue to identify the problem.
|
||||
* **Describe the exact steps which reproduce the problem** in as many details as possible.
|
||||
* **Include relevant information** such as your username on the site, or the person you drafted a pattern for.
|
||||
|
||||
Provide more context by answering these questions:
|
||||
|
||||
* **Did the problem start happening recently** (e.g. it worked fine before but since the latest update it doesn't)
|
||||
* **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: Showcase our patterns
|
||||
---
|
||||
|
||||
Anytime somebody has made one of our patterns, we like to showcase it on [freesewing.org](https://freesewing.org/showcase/).
|
||||
|
||||
Unpublished showcases are tracked as [GitHub issues](https://guides.github.com/features/issues/).
|
||||
Create an issue [in our monorepo](https://github.com/freesewing/freesewing/issues/new?assignees=&labels=%F0%9F%91%8D+good+first+issue%2C+%F0%9F%93%B8+showcase%2C+%F0%9F%A4%97+community&template=showcase-template.md&title=Create+showcase+from+this+content) when you've made one of our patterns, or have come across pictures from another maker who did.
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: Writing for freesewing.dev
|
||||
---
|
||||
|
||||
You could write documentation for freesewing.dev, our developers website.
|
||||
|
||||
You would need good writing skills and a familiarity with code (Javascript).
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Technical writing
|
||||
---
|
||||
|
||||
<ReadMore list />
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: Writing for freesewing.org
|
||||
---
|
||||
|
||||
You could write documentation for freesewing.org, our makers website.
|
||||
|
||||
You would need good writing skills and a familiarity with sewing.
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: Translation
|
||||
---
|
||||
|
||||
You could translate FreeSewing into one of its additional languages
|
||||
(French, German, Dutch, Spanish). Or if you’re ambitious, add a new one.
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
title: Triage issues
|
||||
---
|
||||
|
||||
Triaging issues is a great way to get involved in FreeSewing. You can do tasks such as:
|
||||
|
||||
- Making sure issues are properly labeled
|
||||
- Ensuring they have a good title that explains the issue in brief
|
||||
- Assigning issues to people to make sure they are tended to
|
||||
- Keeping an eye on stale issues, and either updating or closing them
|
||||
- Assigning issues to milestones so we can plan our releases
|
||||
|
||||
All FreeSewing contributors have triage permissions that allows them to do this.
|
||||
If you don't have the rights, or bump into any issues, [reach out to us on Discord](https://discord.freesewing.org).
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: UI / UX Webdesign
|
||||
---
|
||||
|
||||
You could help us make our website and tools pretty and improve the user experience.
|
5
markdown/dev/developers/backend/en.md
Normal file
5
markdown/dev/developers/backend/en.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: The freesewing backend
|
||||
---
|
||||
|
||||
<Fixme>Under construction</Fixme>
|
5
markdown/dev/developers/dev/en.md
Normal file
5
markdown/dev/developers/dev/en.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: The freesewing.dev website
|
||||
---
|
||||
|
||||
<Fixme>Under construction</Fixme>
|
27
markdown/dev/developers/en.md
Normal file
27
markdown/dev/developers/en.md
Normal file
|
@ -0,0 +1,27 @@
|
|||
---
|
||||
title: For developers
|
||||
order: 1120
|
||||
---
|
||||
|
||||
Welcome to the FreeSewing documentation for developers.
|
||||
|
||||
Our core library is a toolbox for parametric sewing pattern design.
|
||||
Here's some of the most relevant reference documentation:
|
||||
|
||||
- [Core API reference](/reference/api/)
|
||||
- [Pattern configuration file](/reference/config/)
|
||||
- [Settings](/reference/settings/)
|
||||
|
||||
We have a [Pattern design tutorial](/tutorials/pattern-design/) that is a
|
||||
good way to familiarize yourself with the FreeSewing platform.
|
||||
|
||||
Alternatively, we have bite-sized guides that cover [prerequisites](/guides/prerequisites/), [patterns](/guides/patterns/), [best practices when designing](/guides/best-practices/), and [plugins](/guides/plugins/).
|
||||
|
||||
#### Not here for core?
|
||||
|
||||
If you are interested the FreeSewing project as a whole, the following links
|
||||
cover different aspects of our setup:
|
||||
|
||||
<ReadMore list />
|
||||
|
||||
|
5
markdown/dev/developers/org/en.md
Normal file
5
markdown/dev/developers/org/en.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: The freesewing.org website
|
||||
---
|
||||
|
||||
<Fixme>Under construction</Fixme>
|
5
markdown/dev/developers/svg2pdf/en.md
Normal file
5
markdown/dev/developers/svg2pdf/en.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: The freesewing on-demand tiler
|
||||
---
|
||||
|
||||
<Fixme>Under construction</Fixme>
|
5
markdown/dev/developers/tiler/en.md
Normal file
5
markdown/dev/developers/tiler/en.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Our tile command line tool
|
||||
---
|
||||
|
||||
<Fixme>Under construction</Fixme>
|
19
markdown/dev/editors/content/dev/en.md
Normal file
19
markdown/dev/editors/content/dev/en.md
Normal 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>
|
16
markdown/dev/editors/content/emails/en.md
Normal file
16
markdown/dev/editors/content/emails/en.md
Normal 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.
|
||||
|
9
markdown/dev/editors/content/en.md
Normal file
9
markdown/dev/editors/content/en.md
Normal 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 />
|
6
markdown/dev/editors/content/newsletter/en.md
Normal file
6
markdown/dev/editors/content/newsletter/en.md
Normal file
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Newsletter
|
||||
order: 40
|
||||
---
|
||||
|
||||
<Fixme>Under construction</Fixme>
|
35
markdown/dev/editors/content/org/en.md
Normal file
35
markdown/dev/editors/content/org/en.md
Normal 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>
|
32
markdown/dev/editors/content/strings/en.md
Normal file
32
markdown/dev/editors/content/strings/en.md
Normal 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>
|
||||
|
25
markdown/dev/editors/en.md
Normal file
25
markdown/dev/editors/en.md
Normal file
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
title: For editors
|
||||
order: 1130
|
||||
---
|
||||
|
||||
Content is king, and as an *editor* content is your baby.
|
||||
|
||||
We have a few different [content sources](/editor/content-sources/) that all have their own
|
||||
specific use-cases, but in general content is one of:
|
||||
|
||||
- 95% **Markdown**: Used for the vast majority of our content.
|
||||
- 4% **YAML**: Used for the internationalisation of our software.
|
||||
- 1% **HTML**: Used in specific places that don't requires internationalisation.
|
||||
|
||||
You guessed it, if you know how to work with markdown, you are already covering
|
||||
95% of all our content. As such, [our Markdown guide](/editors/markdown/) is mandatory
|
||||
reading for all editors. Even if you already know Markdown, you will want to make
|
||||
sure you are aware of all the [custom components](/editors/markdown/custom-components/)
|
||||
we provide.
|
||||
|
||||
<Tip>
|
||||
|
||||
Make sure to check out the howtos on [Common tasks for editors](/editors/howtos/)
|
||||
|
||||
</Tip>
|
13
markdown/dev/editors/howtos/blogpost/add-body/en.md
Normal file
13
markdown/dev/editors/howtos/blogpost/add-body/en.md
Normal file
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
title: Add the body of the blog post
|
||||
order: 90
|
||||
---
|
||||
|
||||
Below the frontmatter, you can write the body of your blog post, [using markdown](/editors/markdown/).
|
||||
|
||||
|
||||
<Tip>
|
||||
|
||||
You can look at [one of the many blog posts](https://github.com/freesewing/markdown/tree/develop/org/blog) for examples.
|
||||
|
||||
</Tip>
|
34
markdown/dev/editors/howtos/blogpost/add-frontmatter/en.md
Normal file
34
markdown/dev/editors/howtos/blogpost/add-frontmatter/en.md
Normal file
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
title: Add the frontmatter
|
||||
order: 40
|
||||
---
|
||||
|
||||
Frontmatter is metadata that we add to the top of the file.
|
||||
Please refere to [working with frontmatter](/howtos/editors/frontmatter/) if you're not sure how to use it.
|
||||
|
||||
The following fields need to be filled in:
|
||||
|
||||
| Name | Description |
|
||||
| ----:| ----------- |
|
||||
| `date` | **Must** be in format `YYYY-MM-DD` |
|
||||
| `title` | Title of the blog post |
|
||||
| `linktitle` | If the title is very long, you can specify an alternative title for use in menus, breadcrumbs, and so on. This field is optional. |
|
||||
| `img` | Filename of the main image. Must be placed in the folder of the showcase |
|
||||
| `caption` | The caption that will go below the image |
|
||||
| `author` | FreeSewing username of the author |
|
||||
|
||||
Below is an example:
|
||||
|
||||
```md
|
||||
---
|
||||
date: 2020-09-09
|
||||
title: FreeSewing 2.9 brings our Teagan T-shirt pattern
|
||||
linktitle: "Our latest pattern is Teagan, a fitted T-shirt"
|
||||
img: teagan2.jpg
|
||||
caption: "Photo by Alex Andrews from Pexels"
|
||||
author: joost
|
||||
---
|
||||
```
|
||||
|
||||
Add the frontmatter to the top of the `en.md` file.
|
||||
|
23
markdown/dev/editors/howtos/blogpost/add-images/en.md
Normal file
23
markdown/dev/editors/howtos/blogpost/add-images/en.md
Normal file
|
@ -0,0 +1,23 @@
|
|||
---
|
||||
title: Add images to the folder
|
||||
order: 30
|
||||
---
|
||||
|
||||
Add the images you want to use to the folder. Keep the following guidelines in mind:
|
||||
|
||||
- The main blog picture should be a landscape image
|
||||
- The best resolution for the main image is 2000x1348 pixels
|
||||
- None of the images should be larger than 2000px on their longest side
|
||||
- Use lowercase for all filenames
|
||||
|
||||
<Note>
|
||||
|
||||
##### Please think twice before dropping a 7Mb image.
|
||||
|
||||
Git never forgets. So if you drop a couple of 7Mb images into our repo,
|
||||
they will be there forever, making cloning the repo very slow.
|
||||
|
||||
So please resize your images before you commit your changes.
|
||||
|
||||
</Note>
|
||||
|
14
markdown/dev/editors/howtos/blogpost/create-file/en.md
Normal file
14
markdown/dev/editors/howtos/blogpost/create-file/en.md
Normal file
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
title: Create a new file for the blog post
|
||||
order: 20
|
||||
---
|
||||
|
||||
In the folder you just created, create a new empty file, and name it `en.md`.
|
||||
|
||||
<Note>
|
||||
|
||||
While we support translation, we do not support adding original content in
|
||||
any language other than English. This is why the file **must** be named
|
||||
`en.md` and be written in English.
|
||||
|
||||
</Note>
|
18
markdown/dev/editors/howtos/blogpost/create-folder/en.md
Normal file
18
markdown/dev/editors/howtos/blogpost/create-folder/en.md
Normal file
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
title: Create a new folder for the blog post
|
||||
order: 10
|
||||
---
|
||||
|
||||
Our [markdown repository](https://github.com/freesewing/markdown/) holds all content
|
||||
for both freesewing.org and freesewing.dev.
|
||||
|
||||
The content for blog posts on freesewing.org is in the `org/blog` folder.
|
||||
|
||||
You'll find a bunch of directories here for all the existing blog posts.
|
||||
Create a new one keeping in mind that this will determine the URL under which the post
|
||||
is available. So:
|
||||
|
||||
- No spaces
|
||||
- No uppercase
|
||||
- Stick to `a-z` and `-` to be safe
|
||||
|
15
markdown/dev/editors/howtos/blogpost/en.md
Normal file
15
markdown/dev/editors/howtos/blogpost/en.md
Normal file
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
title: Adding a blog post on freesewing.org
|
||||
for: editors
|
||||
---
|
||||
|
||||
These are the steps required to add a new [blog post](https://freesewing.org/showcase/) to the website:
|
||||
|
||||
<ReadMore list />
|
||||
|
||||
- Create a new folder in the `org/blog` directory of [our markdown repository](https://github.com/freesewing/markdown/)
|
||||
- Add an `en.md` markdown file to this folder
|
||||
- Add one of more images to the folder
|
||||
- Add the frontmatter to the file
|
||||
- Add the body of the file
|
||||
|
7
markdown/dev/editors/howtos/en.md
Normal file
7
markdown/dev/editors/howtos/en.md
Normal file
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: Common tasks for editors
|
||||
---
|
||||
|
||||
Below is a list of commons tasks for editors
|
||||
|
||||
<ReadMore list />
|
17
markdown/dev/editors/howtos/frontmatter/about/en.md
Normal file
17
markdown/dev/editors/howtos/frontmatter/about/en.md
Normal file
|
@ -0,0 +1,17 @@
|
|||
---
|
||||
title: About frontmatter
|
||||
order: 10
|
||||
---
|
||||
|
||||
Frontmatter is a way to add metadata to markdown documents.
|
||||
|
||||
Frontmatter sits at the top of the file (it's matter that's at the front) and is
|
||||
surrounded by lines with three dashes on them:
|
||||
|
||||
```md
|
||||
---
|
||||
title: This is frontmatter
|
||||
---
|
||||
```
|
||||
|
||||
<ReadMore list />
|
11
markdown/dev/editors/howtos/frontmatter/en.md
Normal file
11
markdown/dev/editors/howtos/frontmatter/en.md
Normal file
|
@ -0,0 +1,11 @@
|
|||
---
|
||||
title: Working with frontmatter
|
||||
for: editors
|
||||
---
|
||||
|
||||
Frontmatter is a way to add metadata to markdown documents.
|
||||
It is used extensively on freesewing.org and freesewing.dev alike.
|
||||
|
||||
Here's what you need to know:
|
||||
|
||||
<ReadMore list />
|
16
markdown/dev/editors/howtos/frontmatter/lists/en.md
Normal file
16
markdown/dev/editors/howtos/frontmatter/lists/en.md
Normal file
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
title: Lists or arrays
|
||||
order: 30
|
||||
---
|
||||
|
||||
Values are typically text or numbers, but you can also make it a list or array.
|
||||
There's two types of syntax for this:
|
||||
|
||||
```md
|
||||
tags: [tag1, another, three]
|
||||
categories:
|
||||
- cat1
|
||||
- anothercat
|
||||
- somethingelse
|
||||
```
|
||||
|
16
markdown/dev/editors/howtos/frontmatter/multi-line/en.md
Normal file
16
markdown/dev/editors/howtos/frontmatter/multi-line/en.md
Normal file
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
title: Mult-line text
|
||||
order: 40
|
||||
---
|
||||
|
||||
To add multi-line text in frontmatter, use a `|` character,
|
||||
and prefix the lines by spaces:
|
||||
|
||||
```md
|
||||
about: |
|
||||
This is a multi-line text
|
||||
that will be assigned to the about key
|
||||
```
|
||||
|
||||
|
||||
|
12
markdown/dev/editors/howtos/frontmatter/structure/en.md
Normal file
12
markdown/dev/editors/howtos/frontmatter/structure/en.md
Normal file
|
@ -0,0 +1,12 @@
|
|||
---
|
||||
title: Structure
|
||||
order: 20
|
||||
---
|
||||
|
||||
Frontmatter is made up of `key: value` pairs.
|
||||
The value must be quoted if you use a `:` in it to avoid problems parsing the key values:
|
||||
|
||||
```md
|
||||
title: This does not need to be quoted
|
||||
slogan: "Markdown: This is the way"
|
||||
```
|
12
markdown/dev/editors/howtos/showcase/add-body/en.md
Normal file
12
markdown/dev/editors/howtos/showcase/add-body/en.md
Normal file
|
@ -0,0 +1,12 @@
|
|||
---
|
||||
title: Add the body of the showcase post
|
||||
order: 50
|
||||
---
|
||||
|
||||
Below the frontmatter, you can write the body of your showcase post, [using markdown](/editors/markdown/).
|
||||
|
||||
<Tip>
|
||||
|
||||
You can look at [one of the many showcases](https://github.com/freesewing/markdown/tree/develop/org/showcase) for examples.
|
||||
|
||||
</Tip>
|
33
markdown/dev/editors/howtos/showcase/add-frontmatter/en.md
Normal file
33
markdown/dev/editors/howtos/showcase/add-frontmatter/en.md
Normal file
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: Add the frontmatter
|
||||
order: 40
|
||||
---
|
||||
|
||||
Frontmatter is metadata that we add to the top of the file.
|
||||
Please refere to [working with frontmatter](/howtos/editors/frontmatter/) is you're not sure how to use it.
|
||||
|
||||
The following fields need to be filled in:
|
||||
|
||||
| Name | Description |
|
||||
| ----:| ----------- |
|
||||
| `date` | **Must** be in format `YYYY-MM-DD` |
|
||||
| `title` | Title of the showcase |
|
||||
| `img` | Filename of the main image. Must be placed in the folder of the showcase |
|
||||
| `caption` | The caption that will go below the image |
|
||||
| `patterns` | An array of designs/patterns that are being showcased. Lowercase only |
|
||||
| `author` | FreeSewing username of the author |
|
||||
|
||||
Below is an example:
|
||||
|
||||
```md
|
||||
---
|
||||
date: 2018-09-29
|
||||
title: Yoga Outfit by Paul
|
||||
img: showcase.jpg
|
||||
caption: "Aaron and Bruce yoga set with stripes by Paul (up-side-down)"
|
||||
patterns: [aaron,bruce]
|
||||
author: Tiger751023
|
||||
---
|
||||
```
|
||||
|
||||
Add the frontmatter to the top of the `en.md` file.
|
23
markdown/dev/editors/howtos/showcase/add-images/en.md
Normal file
23
markdown/dev/editors/howtos/showcase/add-images/en.md
Normal file
|
@ -0,0 +1,23 @@
|
|||
---
|
||||
title: Add images to the folder
|
||||
order: 30
|
||||
---
|
||||
|
||||
Add the images you want to use to the folder. Keep the following guidelines in mind:
|
||||
|
||||
- The main showcase picture should, if possible, be a landscape image
|
||||
- The best resolution for the main image is 2000x1348 pixels
|
||||
- None of the images should be larger than 2000px on their longest side
|
||||
- Use lowercase for all filenames
|
||||
|
||||
<Note>
|
||||
|
||||
##### Please think twice before dropping a 7Mb image.
|
||||
|
||||
Git never forgets. So if you drop a couple of 7Mb images into our repo,
|
||||
they will be there forever, making cloning the repo very slow.
|
||||
|
||||
So please resize your images before you commit your changes.
|
||||
|
||||
</Note>
|
||||
|
14
markdown/dev/editors/howtos/showcase/create-file/en.md
Normal file
14
markdown/dev/editors/howtos/showcase/create-file/en.md
Normal file
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
title: Create a new file for the showcase post
|
||||
order: 20
|
||||
---
|
||||
|
||||
In the folder you just created, create a new empty file, and name it `en.md`.
|
||||
|
||||
<Note>
|
||||
|
||||
While we support translation, we do not support adding original content in
|
||||
any language other than English. This is why the file **must** be named
|
||||
`en.md` and be written in English.
|
||||
|
||||
</Note>
|
18
markdown/dev/editors/howtos/showcase/create-folder/en.md
Normal file
18
markdown/dev/editors/howtos/showcase/create-folder/en.md
Normal file
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
title: Create a new folder for the showcase post
|
||||
order: 10
|
||||
---
|
||||
|
||||
Our [markdown repository](https://github.com/freesewing/markdown/) holds all content
|
||||
for both freesewing.org and freesewing.dev.
|
||||
|
||||
The content for showcases on freesewing.org is in the `org/showcase` folder.
|
||||
|
||||
You'll find a bunch of directories here for all the existing showcases.
|
||||
Create a new one keeping in mind that this will determine the URL under which the showcase
|
||||
is available. So:
|
||||
|
||||
- No spaces
|
||||
- No uppercase
|
||||
- Stick to `a-z` and `-` to be safe
|
||||
|
82
markdown/dev/editors/howtos/showcase/en.md
Normal file
82
markdown/dev/editors/howtos/showcase/en.md
Normal file
|
@ -0,0 +1,82 @@
|
|||
---
|
||||
title: Adding a showcase on freesewing.org
|
||||
for: editors
|
||||
---
|
||||
|
||||
These are the steps required to add a new [showcase](https://freesewing.org/showcase/) to the website:
|
||||
|
||||
- Create a new folder in the `org/showcase` directory of [our markdown repository](https://github.com/freesewing/markdown/)
|
||||
- Add an `en.md` markdown file to this folder
|
||||
- Add one of more images to the folder
|
||||
- Add the frontmatter to the file
|
||||
- Add the body of the file
|
||||
|
||||
Let's look at each step in detail:
|
||||
|
||||
## Create a new folder for the showcase
|
||||
|
||||
|
||||
Our [markdown repository](https://github.com/freesewing/markdown/) holds all content
|
||||
for both freesewing.org and freesewing.dev.
|
||||
|
||||
The content for showcases on freesewing.org is in the `org/showcase` folder.
|
||||
|
||||
You'll find a bunch of directories here for all the existing showcases.
|
||||
Create a new one keeping in mind that this will determine the URL under which the showcase
|
||||
is available. So:
|
||||
|
||||
- No spaces
|
||||
- No uppercase
|
||||
- Stick to `a-z` and `-` to be safe
|
||||
|
||||
## Add an `en.md` file to the folder
|
||||
|
||||
Create an empty file in this folder and name it `en.md`.
|
||||
|
||||
## Add one of more images to the folder
|
||||
|
||||
Add the images you want to use to the folder.
|
||||
|
||||
<Note>We prefer if you use lowercase for all filenames</Note>
|
||||
|
||||
## Add the frontmatter
|
||||
|
||||
Frontmatter is metadata that we add to the top of the file.
|
||||
Please refere to [working with frontmatter](/editors/frontmatter) is you're not sure how to use it.
|
||||
|
||||
The following fields need to be filled in:
|
||||
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| `date` | Must be in format `YYYY-MM-DD` |
|
||||
| `title` | Title of the showcase |
|
||||
| `img` | Filename of the main image. Must be placed in the folder of the showcase |
|
||||
| `caption` | The caption that will go below the image |
|
||||
| `patterns` | An array of designs/patterns that are being showcased. Lowercase only |
|
||||
| `author` | FreeSewing username of the author |
|
||||
|
||||
Below is an example:
|
||||
|
||||
```md
|
||||
---
|
||||
date: 2018-09-29
|
||||
title: Yoga Outfit by Paul
|
||||
img: showcase.jpg
|
||||
caption: "Aaron and Bruce yoga set with stripes by Paul (up-side-down)"
|
||||
patterns: [aaron,bruce]
|
||||
author: Tiger751023
|
||||
---
|
||||
```
|
||||
|
||||
Add the frontmatter to the top of the `en.md` file.
|
||||
|
||||
## Add the body
|
||||
|
||||
Below the frontmatter, you can write the body of your post, [using markdown](/editors/markdown/).
|
||||
|
||||
|
||||
<Tip>
|
||||
|
||||
You can look at [one of the many showcases](https://github.com/freesewing/markdown/tree/develop/org/showcase) for examples.
|
||||
|
||||
</Tip>
|
53
markdown/dev/editors/markdown/code-blocks/en.md
Normal file
53
markdown/dev/editors/markdown/code-blocks/en.md
Normal file
|
@ -0,0 +1,53 @@
|
|||
---
|
||||
title: Code and code blocks
|
||||
order: 80
|
||||
---
|
||||
|
||||
Especially for our developer documentation, there's a lot of times we include source code
|
||||
in the documentation.
|
||||
You can make these look pretty by using a code block.
|
||||
|
||||
The basic use is to wrap your code in three backtick characters on a line:
|
||||
|
||||
````
|
||||
```
|
||||
let me = 'you'
|
||||
```
|
||||
````
|
||||
|
||||
Gives you:
|
||||
|
||||
```
|
||||
let me = 'you'
|
||||
```
|
||||
|
||||
This is a generic code block. But we also support syntax highlighting.
|
||||
To do so, add the language specifier after the opening backticks:
|
||||
|
||||
````
|
||||
```js
|
||||
let me = 'you'
|
||||
```
|
||||
````
|
||||
|
||||
To get:
|
||||
|
||||
```js
|
||||
let me = 'you'
|
||||
```
|
||||
|
||||
The following language codes are supported:
|
||||
|
||||
- `js` for Javascript code
|
||||
- `md` for Markdown
|
||||
- `html` for HTML
|
||||
- `svg` for SVG
|
||||
- `bash` for Bash or shell scripts
|
||||
- `mdx` for MDX
|
||||
- `jsx` for JSX
|
||||
- `json` for JSON
|
||||
- `js-error` for a Javascript error
|
||||
- `js-trace` for a Javascript stack trace
|
||||
|
||||
|
||||
|
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue