Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CMS design needs design documentation for OSS contribution #982

Closed
1 of 5 tasks
t1merickson opened this issue Jan 3, 2018 · 14 comments
Closed
1 of 5 tasks

CMS design needs design documentation for OSS contribution #982

t1merickson opened this issue Jan 3, 2018 · 14 comments

Comments

@t1merickson
Copy link

t1merickson commented Jan 3, 2018

Problem:

Design of Netlify CMS is sporadic or maintained by just a few specific individuals. Design work suggested beyond those specific individuals does not have the benefit of understanding the underlying design system, style, and goals.

Goal:

Create a design system, component library, open source Sketch files, goal documents, mockups, and other tools to encourage designers in the OSS community to be able to contribute to design-specific work on Netlify CMS

This is a start of a container for conversation around this large task, which will support individual design improvements to the CMS

Possible Todos:

  1. Build a storybook library for design components
  2. Draft wireframes for future major design work

Actual TODOs:

  • Setup an open/free Abstract (version control for Sketch files)
  • Write a style guide document
  • Create issues for good first design contribution
  • Create better readme to talk about how to contribute design
  • Create a specific document detailing how to contribute design
@owenhoskins
Copy link

Timely issue @neutyp. I came across this while searching issues in hopes of finding sketch assets to support the minor design needs of #1032. Are there some assets that could be made available at this point?

@t1merickson
Copy link
Author

t1merickson commented Jan 21, 2018

@owenhoskins Yes! Good news for you. We're in the very early stages of a project with Abstract (think of it as GitHub for designers, it's literally version control for Sketch files)

Here is a secret link to signup as a Contributor on our Abstract; https://app.goabstract.com/invitations/321faa873faa7258f56b943bf2fd98f8ca49e76515a19cca457eacedf1bb66b3

PLEASE NOTE:

  1. Your contributor access allows you to create branches and merge. Please only create branches, do not merge to Master. You can then ping me in an GH Issue or PR if you'd like the work merged to Master and I will do it :)
  2. The work you're looking for is in the Netlify CMS Core repo project on Abstract, simply create a branch of Master and you're off and away. Simply commit any changes to your branch through the Abstract Mac app.
  3. We're going to start creating contribution documentation and I'd love to ask for you feedback on how this process works and perhaps a bit of help writing the actual documentation :)

Please let me know if you have any questions! I'm here to help

@t1merickson
Copy link
Author

@ziburski Can you do me a huge favor and follow the same process outlined above to signup as an Abstract contributor? Specifically if there's any netlifycms.org work newer than what's in the relevant project on Abstract?

Also if you ever have desire or time to work on any further Netlify CMS improvements in the future, we'd love to track the Sketch work there! Thanks again for being such a huge support on the design side of this project, your work has continually propelled us forward.

@tech4him1
Copy link
Contributor

@neutyp Do you have a view/comment only link as well? If we wanted to, we could add that link to our public documentation, and have contributors ask for permission if they want to get write access.

@t1merickson
Copy link
Author

t1merickson commented Jan 21, 2018

@tech4him1 Yes! This is the link anyone can use to be a Viewer/Guest which allows access even if you don't have a Mac or Sketch (can be used entirely on the web)

https://app.goabstract.com/invitations/ede49f35837d68035f4a6a242937ec2db7e9b9c6a4076805d21c9a1884238e82

@t1merickson
Copy link
Author

@tech4him1 Please note I copy pasted the wrong link; the above comment has now been updated with the right one

@tech4him1
Copy link
Contributor

Working. Both links say that I'm added as a member -- I can't see if they give me different permissions, though, since I'm not on a Mac.

@t1merickson
Copy link
Author

@tech4him1 The links confused even me. I just gave feedback to Abstract privately about that, FYI. At any rate, on my backend I can confirm you signed up as a Viewer, and Lennart just signed up as a Contributor, so the links are working perfectly!

@ziburski
Copy link
Contributor

Specifically if there's any netlifycms.org work newer than what's in the relevant project on Abstract?

The one on Abstract is the latest Sketch file. The last iterations were done straight in markup and weren’t documented in Sketch. I agree it would be nice to have though.

I won’t have time to contribute much in the near future, but Abstract should make it very easy to follow along with the design process and chime in when something comes up. Props for trying that new approach!

@ziburski
Copy link
Contributor

@neutyp Oh, I lied. I do have a slightly updated version of the website Sketch file. Just created a new branch on Abstract for it. Did I do it right? It takes a while to get used to the workflow in a design context.

@t1merickson
Copy link
Author

@ziburski yep, perfect! thanks for taking a moment to double check this!

@erquhart
Copy link
Contributor

🎉🎉🎉 to all of this

@stale
Copy link

stale bot commented Oct 29, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the status: stale label Oct 29, 2019
@martinjagodic
Copy link
Member

Closing as stale and/or outdated.

@martinjagodic martinjagodic closed this as not planned Won't fix, can't repro, duplicate, stale Apr 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants