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

Merge pattern library into platform-client #3633

Open
rjmackay opened this issue Nov 29, 2017 · 11 comments

Comments

@rjmackay
Copy link
Contributor

commented Nov 29, 2017

Why?

The pattern library has become hard to maintain - with packages sometimes breaking and sometimes lagging behind platform-client. We want to encourage developers (and OSS users) to make changes to the pattern library when needed without the friction of moving form one system to another

How

The initial shift will be mostly a move, rather than a refactor

- [ ] Move existing pattern library markup to platform-client/pattern-library
- [ ] Move existing pattern library sass into platform-client/sass
- [ ] Move font and img assets to platform-client/assets ? (not sure on naming)
- [ ] Move JS to platform-client/pattern-library/js ?
- [ ] Create a simple webpack config to build and develop on the PL.
- This should render pattern library templates, CSS and JS

  • Migrate bourbon and neat dependencies to npm rather than bower
  • Remove handlebars templating or render templates at build time, not in the browser
  • Set up auto deployment of built PL to preview.ushahidi.com again

Maybe:

  • Combine Basics and Fragments, and some of the 'modules' into a single section?
  • Combine complex Modules and block into a single sections?
    • I've never found it obvious what was considered a fragment and module or a block.
@Angamanga

This comment has been minimized.

Copy link
Contributor

commented Nov 29, 2017

@rjmackay Does this mean just moving the handlebars js just as is? Moving to angular is a totally different issue maybe?

@Angamanga

This comment has been minimized.

Copy link
Contributor

commented Nov 29, 2017

@rjmackay Actually nevermind, when I think about it, since we are considering changing js-framework its better to wait on that before doing anything...

@rjmackay

This comment has been minimized.

Copy link
Contributor Author

commented Nov 29, 2017

I'm not sure the pattern library should rely on angular or other JS frameworks. Keeping it as simple static HTML is more useful - nothing to break, its just a testbed for CSS.
Though maybe we need a testbed for UI components too - but they should probably be semi-separate.

@sethburtonhall

This comment has been minimized.

Copy link

commented Nov 29, 2017

I agree with all of this @rjmackay, especially removing Handlebars and the confusion between Modules/Blocks, etc... The main issue for me would be setting up the WebPack build and the auto deployment.

@sethburtonhall

This comment has been minimized.

Copy link

commented Jan 8, 2018

So for now the plan is to keep the PL to Platform flow as is, but drastically simplify the PL, making it easier for devs to jump in and revise/create components. Basically this means removing unnecessary dependencies like Handlebars. It would be helpful if @crcommons @Angamanga @justinscherer can chime in real quick to remind me of the biggest issues and blockers. @rjmackay has listed some above but your feedback will help determine how it needs to be simplified. Thank you.

@Angamanga

This comment has been minimized.

Copy link
Contributor

commented Jan 9, 2018

@middle8media It looks good to me. I would like to add that while/if we look at the modules, blocks and fragments, we should also go through each section and see if the html differ from the layouts (I think they do in some cases) and correct this. We should add parts from the layouts that are not present in the modules/blocks/fragments and remove those who are not used anymore. To clean it up a bit.

@justinscherer

This comment has been minimized.

Copy link
Collaborator

commented Jan 9, 2018

@Erioldoesdesign suggested an interface inventory which we should probably do anyways. This might catch the misalignments @Angamanga

@sethburtonhall

This comment has been minimized.

Copy link

commented Jan 30, 2018

@rjmackay I'd like to chat more about these:

Remove handlebars templating or render templates at build time, not in the browser

Set up auto deployment of built PL to preview.ushahidi.com again

@rjmackay

This comment has been minimized.

Copy link
Contributor Author

commented Jan 31, 2018

Set up auto deployment of built PL to preview.ushahidi.com again

It should still be auto deploying through Travis-CI. The latest build seems to have passed and deploy: https://travis-ci.org/ushahidi/platform-pattern-library/jobs/334892948
Are you seeing issues?

@sethburtonhall

This comment has been minimized.

@sethburtonhall

This comment has been minimized.

Copy link

commented Aug 30, 2018

Can we close this? I think this would be covered via the React CL

@sethburtonhall sethburtonhall removed their assignment Sep 7, 2018

@rowasc rowasc transferred this issue from ushahidi/platform-client Aug 11, 2019

@rowasc rowasc added the Needs Triage label Aug 11, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants
You can’t perform that action at this time.