From 87d1e51af30d0f351f769ff3776677619d2428d9 Mon Sep 17 00:00:00 2001 From: Gabe Kangas Date: Fri, 9 Dec 2022 15:33:07 -0800 Subject: [PATCH] Add design doc for contribute.design. Closes #2413 --- .design/DESIGN.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++ docs/DESIGN.md | 3 +++ 2 files changed, 62 insertions(+) create mode 100644 .design/DESIGN.md create mode 100644 docs/DESIGN.md diff --git a/.design/DESIGN.md b/.design/DESIGN.md new file mode 100644 index 000000000..6018b8971 --- /dev/null +++ b/.design/DESIGN.md @@ -0,0 +1,59 @@ +# Owncast Design Guidelines & Resources + +A collection of design contribution guidelines and resources for the Owncast interface. + +> **All participating designers are highly encouraged to shape and evolve these guidelines!** +> It is a work in progress and as we have design contributors we can work to solidify the process, tools and resources. + +## 👋 Welcome + +Owncast is a is a live streaming and chat server targeted to anybody who has live streaming needs. This means anybody from corporate events, government meetings, game streamers, musicians, churches, TV stations, and more. + +Read the detailed [product definition](https://github.com/owncast/owncast/blob/develop/docs/product-definition.md) to learn more. + +## 🚢 How to contribute to product design + +1. Check out open [issues](https://github.com/owncast/owncast/issues) here on GitHub (we label them with `needs design`) +2. Feel free to open an issue on your own if you find something you would like to contribute to the project. +3. Add your contributions to an issue and we promise we will review your contribution carefully and foster discussions + +**We encourage you to:** + +- Get in touch with the team by joining our [Community Chat](https://owncast.rocket.chat). +- Check out our [Contributor Guide](https://owncast.online/help) and + [Code of Conduct](https://github.com/owncast/owncast/blob/develop/CODE_OF_CONDUCT.md) + +## 🎭 Target audience + +Owncast is a is a live streaming and chat server targeted to anybody who has live streaming needs. This means anything from corporate events, government meetings, game streams, concerts, TV stations, and more. + +## 💅 Design relevant materials + +Here is a list of design relevant information and materials: + +### Fonts + +http://owncast.online/components/?path=/story/owncast-style-guide-typography--page + +Body text: OpenSans + +Display/Header text: Poppins + +### Colors + +http://owncast.online/components/?path=/story/owncast-style-guide-default-theme--page + +### Design Files, Screenshots, etc + +We do not currently have any design files that fully represent the state of +the Owncast interface. However going forward it would be nice to resolve this +and collaborate on designs. + +We do have a [PenPot organization](https://design.penpot.app/#/dashboard/team/8373f780-f255-11ec-b774-f940e3befd53/projects). Please ask for access. + +## 🎓 License + +All design work is licensed under the +[MIT](https://mit-license.org/) + +[(Back to top)](#-table-of-contents) diff --git a/docs/DESIGN.md b/docs/DESIGN.md new file mode 100644 index 000000000..c97b7cd03 --- /dev/null +++ b/docs/DESIGN.md @@ -0,0 +1,3 @@ +See the design contributions document at + +https://github.com/owncast/owncast/blob/develop/.design/DESIGN.md