Doc generation #86

fragsalat · 2017-06-16T13:23:07Z

Try to fix version generation by allowing circle ci to push to master
Fixed generation of api doc
Added documentation for date picker and notification

… component and fixed small bug

…r folder

…s into doc-generation

faboweb · 2017-06-20T08:48:59Z

circle.yml

@@ -19,7 +19,7 @@ checkout:
  post:
    - git pull origin ${CIRCLE_BRANCH}
    - git clone git@github.com:wholesale-design-system/styleguide.git
-    - git config --global user.email circleci@circleci
+    - git config --global user.email t.schlage@gmx.net


maybe use different PRs

in the future

I would say, in the future something like "tech-fabric@zalando.de" where all engineers working with it are subscribed ^^

As I said you can create such a user if you want :D
I don't know where to store the credentials in a secure way so that also peoples after us get the access.

faboweb · 2017-06-20T08:49:45Z

doc/components/date-picker.md

+<ws-date-picker
+  value="2017-06-15"
+  format="Y-m-d" 
+  options='{"minDate": "2017-06-01", "maxDate": "2017-06-24"}'>


should we change the format directly to min/max attributes like discussed?

Yes but lets to this in a specific PR :)

faboweb · 2017-06-20T08:50:05Z

doc/components/date-picker.md

+```html
+<ws-date-picker
+  value="2017-06-15"
+  format="Y-m-d" 


do we need format?

Actually it was a requirement by CAT and it makes sense because the backend requires specific date formats.

I think the displaying of the date should be unified. @wholesale-design-system/ux
Processing the date afterwards to send it to the backend can be done by each application differently.

We can align for Wholesale but since we want to give the styleguide to others we can not enforce them to use a specific formatting.

discussed in #87

faboweb · 2017-06-20T08:54:23Z

doc/components/dropdown.md

@@ -26,6 +26,11 @@ like `text="Click me" icon="icon-filter"`. As following you can see an example o
  </div>
 </div>

+**Disabled**
+As any common html element the dropdown can be disabled by adding the `disabled="1"` flag to it.


disabled="1" is confusing. disabled is not really a boolean attribute: https://codepen.io/anon/pen/NgpZYe

I recommend just using "disabled"

It is not working everywhere. The problem is that disabled will result in the property disabled: "" which will be false.

is this a React thing?
if it is about implementation do the check props.disabled!==undefined (or sth like that) this results in the same behaviour as native

It is a HTML and wrapper thing. If you call getAttribute('name') and you define disabled as a flag it will return an empty string which will be false. So either you define a list of boolean attributes or create the convention that every attribute which has an empty string will be boolean. Btw as far as I know disabled="1" is valid HTML.

It is valid HTML but I just say it gives the wrong impression as disabled="false" is still disabling a button: https://codepen.io/anon/pen/owwdEp

My approach is here https://codepen.io/anon/pen/GEEdXP

Well, as you both discussed this I checked if disabled="1" is really valid XHTML specification and it is not. If you use W3C Validator it shows you an error.

For example, setting the disabled attribute to the value "false" is disallowed, because despite the appearance of meaning that the element is enabled, it in fact means that the element is disabled (what matters for implementations is the presence of the attribute, not its value).

or

A number of attributes are boolean attributes. The presence of a boolean attribute on an element represents the true value, and the absence of the attribute represents the false value.

from here:
http://w3c.github.io/html/single-page.html#sec-boolean-attributes

so basically:

<input type="text" disabled /> <input type="text" disabled="" /> <input type="text" disabled="disabled" />

See: https://codepen.io/fokusferit/pen/gRoWKd (disabled="{0,1, lala, ...}" everything disables the button.

faboweb · 2017-06-20T08:55:41Z

doc/components/notification.md

+The type of the event has to be `ws-notification-open` and the details has to be an object containing:
+- **title**: string, required
+- **description**: string, optional
+- **type**: info|error|warning|success, default: info


idk maybe mention those are strings?

faboweb · 2017-06-20T08:56:16Z

doc/components/dropdown.md

@@ -26,6 +26,11 @@ like `text="Click me" icon="icon-filter"`. As following you can see an example o
  </div>
 </div>

+**Disabled**
+As any common html element the dropdown can be disabled by adding the `disabled="1"` flag to it.
+The style of the trigger will change and the dropdown con not be opened any more.


typo: con => can

…sible

fragsalat and others added 9 commits June 2, 2017 13:42

Implemented automatic release version and changelog generation

b03b3ab

feat(documentation): Fixed api doc generation, added doc for dropdown…

2868ef0

… component and fixed small bug

fix(documentation): Fixed API generation to only generate one file pe…

92060a5

…r folder

Merge branch 'master' of github.com:wholesale-design-system/component…

cff822d

…s into doc-generation

Merge branch 'master' into doc-generation

b167e89

Moved document linting into separate task

4573649

feat(documentation): Added new doc for date picker and notification

adafaec

Merge branch 'master' of github.com:wholesale-design-system/component…

dd73931

…s into doc-generation

Set real email

87b21f8

faboweb reviewed Jun 20, 2017

View reviewed changes

fragsalat added 3 commits June 20, 2017 11:08

Fixed PR feedback, removed obsolete docs folder

3e599ae

fix(date-picker): Made changing format of date picker only global pos…

9ad94c9

…sible

fix(documentation): Changed dropdown disabled documentation

2f8532b

faboweb approved these changes Jun 29, 2017

View reviewed changes

fragsalat merged commit 8ad1613 into master Jul 4, 2017

fragsalat deleted the doc-generation branch July 4, 2017 12:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Doc generation #86

Doc generation #86

fragsalat commented Jun 16, 2017

faboweb Jun 20, 2017

faboweb Jun 20, 2017

fokusferit Jun 28, 2017

fragsalat Jun 29, 2017

faboweb Jun 20, 2017

fragsalat Jun 20, 2017

faboweb Jun 20, 2017

faboweb Jun 20, 2017

fragsalat Jun 20, 2017

faboweb Jun 20, 2017

fragsalat Jun 20, 2017

faboweb Jun 29, 2017

faboweb Jun 20, 2017

faboweb Jun 20, 2017

fragsalat Jun 20, 2017 •

edited

Loading

faboweb Jun 20, 2017

fragsalat Jun 20, 2017

faboweb Jun 22, 2017

fokusferit Jun 28, 2017

faboweb Jun 20, 2017

faboweb Jun 20, 2017

Doc generation #86

Doc generation #86

Conversation

fragsalat commented Jun 16, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fragsalat Jun 20, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fragsalat Jun 20, 2017 •

edited

Loading