Maybe something that could help ease the transition would be a tool that would allow initial design document creation in Google docs with exporting to markdown on Github for community refinement/commenting. There are a number of projects that allow for initial content creation using Google docs and then conversion to markdown:
https://chrome.google.com/webstore/detail/gabriel/okimajjeocnndpifeelaajdebkkbckff?hl=en-GB <https://chrome.google.com/webstore/detail/gabriel/okimajjeocnndpifeelaajdebkkbckff?hl=en-GB> https://stackedit.io/ <https://stackedit.io/> - this looks neat - it allows for creation in google docs and uploading in markdown format directly to GitHub. It’s open source, too. -Dana > On Jun 16, 2016, at 7:03 AM, Andres Galante <[email protected]> wrote: > > Hi Matt, > > You are right, even though you can comment inline on a PR like Leslie > mention, inline comments on github are not as well organize as the ones in > gdocs. > > But I think that is a fair price to pay, to get open our process. Una Kravets > shares her experience moving her design team to git and she shares her > experience in this talk: https://www.youtube.com/watch?v=hBp6nP_hqBM > <https://www.youtube.com/watch?v=hBp6nP_hqBM> > > If you have half an hour its worth watching it. > > Thanks! > > > > On Wed, Jun 15, 2016 at 2:52 PM, Leslie Hinson <[email protected] > <mailto:[email protected]>> wrote: > I think this is great because documentation will be more accessible. I've > also enjoyed learning GitHub and gaining a better understanding of the > workflow there. > > To address Matt's question, I had the same question. Brian Leathem quickly > showed me how you could do commenting. I think it was specifically on a PR > though? My only point being, I think there is some capabilities that we would > be able to utilize to work in a similar way as we do now. > > Leslie > > > > On Tue, Jun 14, 2016 at 2:44 PM, Matt Carrano <[email protected] > <mailto:[email protected]>> wrote: > Hi Andres, > > The process you have proposed sounds great and I like the idea of using > GitHub as a common repository for design as well as code. I agree it will > make contributions easier and provide a way to file issues against a design > pattern that can help our work evolve and improve. True, we designers will > need to become more proficient in Git, but hey, it's just another tool to > learn. > > My only minor concern is the use of Markdown to create documents rather than > Google Docs as is the current practice. The markdown syntax seems simple > enough to learn, but we would loose some of the more robust inline commenting > features which make Google Docs great for collaboration. Will these markdown > documents be directly consumable into the site? If so, I see this as a major > advantage. > > Anyway, I'm willing to give this a try, but it might make sense to pilot one > or two pattern efforts to see how this goes. > > Matt > > On Tue, Jun 14, 2016 at 1:05 PM, Andres Galante <[email protected] > <mailto:[email protected]>> wrote: > Hi, > > We've wrote new Contribution Guidelines to improve the way we get > contributions to patternfly, and find a path for designers to participate in > the community. > > We want to centralise everything in github. > > At the moment designs patterns don’t have a real place, they are spread on > docs, or on the website. > > We want for design specs to be living document with a fiscal representation > on a github repo just as we do it with code. > > The process to send code is though a github pull request. That pull request > gets discuss and merge. And if we see an bug in it, we open an issue and send > a new pull request with the fix. That fix is discuss again and merge. > > The idea is to follow the same process for designs and designers. > > We will have a repo for designs, where designers will send markdown > documents. Markdown allows to easily write text and add images to describe > the pattern. > > Designers will send design draft on Pull Request, where we will held design > discussions > > Once we merge the design draft, it becomes a design recommendation. But of > course, since it is also a living document we can send new PRs up update it. > > This will also allow to easily cross reference design and code PRs in > Patternfly and with other projects. > > What's the cost? Designers will have to learn git. But don’t worry it's not > that hard. Once you do it once then it becomes second nature, plus its super > fun and it's the way open source communities works. > > To pull all of this together we've wrote new contribution guidelines, and I'd > love to hear your thoughts before posting them to the project: > > https://gist.github.com/andresgalante/a0d8238d8cd448b14eac9c377e76d489 > <https://gist.github.com/andresgalante/a0d8238d8cd448b14eac9c377e76d489> > > Thanks! > > _______________________________________________ > Patternfly mailing list > [email protected] <mailto:[email protected]> > https://www.redhat.com/mailman/listinfo/patternfly > <https://www.redhat.com/mailman/listinfo/patternfly> > > > > > -- > Matt Carrano > Sr. Interaction Designer > Red Hat, Inc. > [email protected] <mailto:[email protected]> > > _______________________________________________ > Patternfly mailing list > [email protected] <mailto:[email protected]> > https://www.redhat.com/mailman/listinfo/patternfly > <https://www.redhat.com/mailman/listinfo/patternfly> > > > > _______________________________________________ > Patternfly mailing list > [email protected] > https://www.redhat.com/mailman/listinfo/patternfly
_______________________________________________ Patternfly mailing list [email protected] https://www.redhat.com/mailman/listinfo/patternfly
