Updated Peertube setup with Ansible and Docker Compose (markdown)
[oweals/peertube.wiki.git] / Contribute-to-design.md
index 770fefebc092486a369db0e254f8433027a50da4..e411a0eb5049e2468ab9a1f7c720c34cfca7be50 100644 (file)
@@ -1,7 +1,6 @@
 <!-- This guide is heavily inspired by GitLab's own contributing guide for its design team. Kudos to them! -->
 
-Thank you for your interest in contributing to PeerTube's design. This guide details how
-to contribute in a way that is efficient for everyone.
+Thank you for your interest in contributing to PeerTube's design. Our team is building a software, but we don't forget its core concept still is to interact with people. Here's how you can help them better get along.
 
 ---
 
@@ -16,11 +15,7 @@ to contribute in a way that is efficient for everyone.
   - [Open Source Design](#open-source-design)
   - [Suggested workflow](#suggested-workflow)
   - [Suggested Software](#suggested-software)
-    - [Sketch](#sketch)
-    - [Adobe XD](#adobe-xd)
 - [Organization](#organization)
-  - [Naming](#naming)
-  - [Files and folders](#files-and-folders)
   - [Pages and artboards](#pages-and-artboards)
 - [Git](#git)
   - [Commits](#commits)
@@ -38,11 +33,16 @@ The project is still low on resources and no dedicated design team has been esta
 
 We care about [Open Source Design](http://opensourcedesign.net/goals/), and Open Design in general. Making the design process open is an important thing for us, as interfaces too can greatly impact the resulting software, in bad or good.
 
+It implies putting your files in the open and iterating to modify it with others until consensus. More specifically, it means dividing a given design problem in manageable parts, and track them [in public](issue-link) for us to help :smiley:.
+
+You might want to read some more here, although these are just hints:
+- http://opendesignkit.org/process/
+
 ### Suggested workflow
 
 1. See what you think about is being tackled by others on the [issue tracker](issue-link)
 1. Think of using pen & paper. High-end software isn't the goal. Design is.
-1. [Fork this project][fork-link] to your personal namespace. Or don't: it's just a suggested skeleton project to help you get started and structure your proposal.
+<!-- 1. [Fork this project][fork-link] to your personal namespace. Or don't: it's just a suggested skeleton project to help you get started and structure your proposal. -->
 1. Create a repository from your fork.
    - Be very descriptive of the changes you've made. The reviewer will have to manually merge them, which means they have to be aware of even the smallest changes as they could be easy to miss.
 1. Create an issue on [PeerTube's repository](issue-link).
@@ -55,54 +55,10 @@ We care about [Open Source Design](http://opensourcedesign.net/goals/), and Open
 
 Again, think of using [paper & pencil first](http://alistapart.com/article/paperprototyping).
 
-We recommend first and foremost open source software such as [Inkscape](https://inkscape.org/en/) or [Pencil](http://pencil.evolus.vn/) (a [complete list](http://opensourcedesign.net/resources/#design-tools)), but at the same time we know most of them are behind popular software for web design workflows. You can use any design software that's available to you. Just make sure to include editable exports (SVG, PDF, EPS) along with your source files.
-
-#### Sketch
-
-Some pointers to open files from [Sketch](https://www.sketchapp.com/):
-
-- [Sketch-react](https://zjuasmn.github.io/sketch-react/): Web app that supports multiple pages. Admits uploading files and referencing by URL.
-- [Sketch Web Viewer](https://animaapp.github.io/sketch-web-viewer/): Web app that supports uploaded files.
-- [Figma](https://www.figma.com/): Powerful tool for UX and UI design. It has a web interface as well as desktop apps (internet connection required). It’s free for individuals.
-- [Photopea](https://www.photopea.com/): Free web editor for Sketch, Photoshop and Gimp files. The only editable export format is PSD, which may not be fully compatible for Sketch import.
-
-We recommend installing the following Sketch plugins to improve your design
-workflow. Don’t forget to read the documentation of each plugin to use them
-properly. If you’d like to recommend a plugin, please [create an issue](https://PeerTube.com/PeerTube-org/PeerTube-design/issues/new).
-
-- [Relabel Button](https://github.com/kenmoore/sketch-relabel-button): Prompts for a button’s new label, applies the text, resizes the button background, and repositions any other interior elements while maintaining the existing padding. It’s essentially awesome voodoo magic.
-- [Git Plugin](https://mathieudutour.github.io/git-sketch-plugin/): A Git client built right into Sketch. The plugin really improves the review process by exporting an image for every part of the design.
-
-#### Adobe XD
-
-Some pointers to open files from [Adobe XD](https://www.adobe.com/fr/products/xd.html).
+We recommend first and foremost open source software such as [Inkscape](https://inkscape.org/en/) or [Pencil](http://pencil.evolus.vn/) (a few others: [mockup tools](https://mastodon.social/@jancborchardt/100746840345081751) and [design tools](http://opensourcedesign.net/resources/#design-tools)), but at the same time we know most of them are behind popular software for web design workflows. You can use any design software that's available to you. Just make sure to include editable exports (SVG, PDF, EPS) along with your source files.
 
 ## Organization
 
-### Naming
-
-Follow these guidelines when naming files and folders, as well as
-layers and styles in your source files:
-- Adhere to [BEM naming convention](http://getbem.com/naming/): `block-name__element-name--modifier-name`
-- Readability above truncation: `background` instead of `bg`
-- `lowercase` everywhere
-- Separate words with dashes, `no-spaces`
-
-### Files and folders
-
-```
-- [group-label]/ (e.g. platform)
-  - [subject-labels]/ (e.g. settings)
-    - projecthandle#issueID-title.sketch (e.g. ce#1337-awesome-design.sketch)
-    - [projecthandle#issue-ID-title]/
-      - projecthandle#issueID-title--state-one.sketch
-      - projecthandle#issueID-title--state-two.sketch
-        - assets/
-          - asset.svg
-```
-
-In any case, if the project becomes too complex (i.e. for a complete redesign proposal, please refer to the [design proposals section](#major-design-proposals).
-
 ### Pages and artboards
 
 In terms of organization method, use the one that best suits you. However, if