chore(markdown): Redistributed contributor docs
This commit is contained in:
parent
424bb7296a
commit
2b8951bd2d
64 changed files with 35 additions and 39 deletions
5
markdown/dev/reference/terms/backend/en.md
Normal file
5
markdown/dev/reference/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/reference/terms/commit/en.md
Normal file
7
markdown/dev/reference/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/reference/terms/contributor-call/en.md
Normal file
8
markdown/dev/reference/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://discord.freesewing.org/
|
8
markdown/dev/reference/terms/contributor/en.md
Normal file
8
markdown/dev/reference/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/reference/terms/design-pattern/en.md
Normal file
11
markdown/dev/reference/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/reference/terms/developer/en.md
Normal file
5
markdown/dev/reference/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/reference/terms/discord/en.md
Normal file
7
markdown/dev/reference/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/reference/terms/editor/en.md
Normal file
6
markdown/dev/reference/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/reference/terms/en.md
Normal file
13
markdown/dev/reference/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/reference/terms/express/en.md
Normal file
7
markdown/dev/reference/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/reference/terms/freesewing.dev/en.md
Normal file
5
markdown/dev/reference/terms/freesewing.dev/en.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: freesewing.dev
|
||||
---
|
||||
|
||||
Our website for developers.
|
107
markdown/dev/reference/terms/freesewing.org/en.md
Normal file
107
markdown/dev/reference/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/reference/terms/freesewing/en.md
Normal file
5
markdown/dev/reference/terms/freesewing/en.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: FreeSewing
|
||||
---
|
||||
|
||||
FreeSewing refers to the community-driven open source project.
|
5
markdown/dev/reference/terms/frontend/en.md
Normal file
5
markdown/dev/reference/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/reference/terms/gatsby/en.md
Normal file
7
markdown/dev/reference/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/reference/terms/i18n/en.md
Normal file
7
markdown/dev/reference/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/reference/terms/issue/en.md
Normal file
9
markdown/dev/reference/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/reference/terms/javascript/en.md
Normal file
6
markdown/dev/reference/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/reference/terms/made-to-measure/en.md
Normal file
5
markdown/dev/reference/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/reference/terms/markdown/en.md
Normal file
9
markdown/dev/reference/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/reference/terms/monorepo/en.md
Normal file
9
markdown/dev/reference/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/reference/terms/node/en.md
Normal file
5
markdown/dev/reference/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/reference/terms/patron/en.md
Normal file
5
markdown/dev/reference/terms/patron/en.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Patron
|
||||
---
|
||||
|
||||
A person who supports FreeSewing financially.
|
5
markdown/dev/reference/terms/plugin/en.md
Normal file
5
markdown/dev/reference/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/reference/terms/pull-request/en.md
Normal file
9
markdown/dev/reference/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/reference/terms/react/en.md
Normal file
7
markdown/dev/reference/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/reference/terms/repo/en.md
Normal file
5
markdown/dev/reference/terms/repo/en.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Repo
|
||||
---
|
||||
|
||||
Short for [repository](/contributors/terms/repository/).
|
7
markdown/dev/reference/terms/repository/en.md
Normal file
7
markdown/dev/reference/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/reference/terms/tiler/en.md
Normal file
9
markdown/dev/reference/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/reference/terms/translator/en.md
Normal file
5
markdown/dev/reference/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.
|
Loading…
Add table
Add a link
Reference in a new issue