search

wet-boew / wet-boew-styleguide

A style guide for the Web Experience Toolkit.
http://wet-boew.github.io/wet-boew-styleguide/index-en.html
35 stars 32 forks source link

New Style Guide? #363

Closed ghost closed 5 years ago

ghost commented 5 years ago

So I was clean up my emails notice a few open issues for this repo. When looking into a few of them this repo is very broken. Things I noticed:

I'm having a hard time understanding .gitmodules, .travis.yml, Gruntfile.coffee, package-lock.json, package.json and where they are collecting and generating some of the HTML content. I believe it the wet-boew-dist repo, but unsure.

@duboisp Thoughts?

duboisp commented 5 years ago

The main issue is the build script on that repository is currently broken essentially because it's not compatible with the recent version of nodejs.

Using a build script that require nodejs might over complicate the goal of this repository.

Do you have any proposal on how we can better manage this style guide? May be by using a jekyll template like I did for the wet-boew-documentation website?

What do you think?

ghost commented 5 years ago

Jekyll would defiantly simplify the repo and make it easier to fix some of the issues (or do updates in future).

duboisp commented 5 years ago

Do you want to try to do that conversion?

The biggest job would be to migrate the handlebar (.hbs) into a markdown (.md) equivalent files. And for the example that require custom markup would require to use the jekyll escape like 

{::nomarkdown}
{% raw %}
...HTML code here...
{% endraw %} {:/}
ghost commented 5 years ago

I don't mind.

Would we also need to pull over the following:

From wet-boew-documentation repo?

On a different note some of the original files from this repo (including the old folder and design-templates) could be migrated into a folder called archived.

duboisp commented 5 years ago

ok, do what need to be done.

For topic where it's make sense, feel free to link back to section in the https://design.gccollab.ca/ . I know in the future, there is a moderated risk to have both projects end up being aligned.

ghost commented 5 years ago

@duboisp I don't have the ability, but the link on main page:

FROM (http://wet-boew.github.io/wet-boew-styleguide/v4/index-en.html): Screen Shot 2019-04-11 at 9 12 12 AM

TO: http://wet-boew.github.io/wet-boew-styleguide/index-en.html

ghost commented 5 years ago

I'll also do some testing and see if any links are incorrect, since I was testing on a localhost it quite possible.

duboisp commented 5 years ago

I am sending a PR that will fix that in a minutes

duboisp commented 5 years ago

see #367

ghost commented 5 years ago

Also this update appears to address the following issues:

142/#220

266

273

352

duboisp commented 5 years ago

You should be able to merge my PR and close those issue.

ghost commented 5 years ago

Your PRs are merged, I also submitted one to fix different issues. Should I merge it?

ghost commented 5 years ago

Nevermind internet slow lately, see it merged, closing issue and the other ones.

ghost commented 5 years ago

Closing as fixed by https://github.com/wet-boew/wet-boew-styleguide/pull/364, https://github.com/wet-boew/wet-boew-styleguide/pull/365, https://github.com/wet-boew/wet-boew-styleguide/pull/366, and https://github.com/wet-boew/wet-boew-styleguide/pull/367.

FYI: WET v3 and the original WET v4 style guide are both archived in the archive folder.