rackerlabs / design-system

Design documentation for Helix, the Rackspace Design System
11 stars 14 forks source link

Text conventions #536

Closed chri2547 closed 6 years ago

chri2547 commented 6 years ago

All the pages of text conventions.

image

image

image

image

image

image

palindromebart commented 6 years ago

That's what I was thinking exactly. cool.

On Thu, Jun 21, 2018 at 3:04 PM, Christopher Moyer <notifications@github.com

wrote:

@chri2547 commented on this pull request.

In _docs/style/text-conventions/labels.md https://github.com/rackerlabs/design-system/pull/536#discussion_r197260230 :

@@ -0,0 +1,62 @@ +--- +title: Labels +layout: docs +parent: Text Conventions +category: Style +usage: |

  • A label is a graphical element that displays text on control panel page. Use a label to identify sections on a page and navigation menu items.

Ok, I did a bit more research on 'label' and found this: "A label is a graphical control element which displays text on a form. It is usually a static control; having no interactivity."

...which means, that you are correct, a menu item is NOT a label, since it is interactive. Since labels are static, we're left with content labels and menu groups.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/rackerlabs/design-system/pull/536#discussion_r197260230, or mute the thread https://github.com/notifications/unsubscribe-auth/AE4ycoxt4PkL1a0sDSnK5PDpvrKG4xRFks5t-_xYgaJpZM4USSEm .

--

M. Barton Renner Experience Design & Interaction Design & Design Strategy @palindromebart https://twitter.com/PalindromeBart | bartrenner.com http://www.bartrenner.com

palindromebart commented 6 years ago

does that make labels a subsection of another text conventions page then?

On Thu, Jun 21, 2018 at 3:07 PM, Christopher Moyer <notifications@github.com

wrote:

@chri2547 commented on this pull request.

In _docs/style/text-conventions/labels.md https://github.com/rackerlabs/design-system/pull/536#discussion_r197261073 :

+last-modified: 2018-06-01 +--- + +{% include toc.html %} + +

+ +
+ +{% column left:"hxCol-12 hxCol-xs-12 hxCol-sm-12 hxCol-md-12 hxCol-lg-12" %} + +## Menu labels + +A menu contains menu items that users use to navigate the pages of a control panel. + +Consider the following guidelines when labeling menu items:

Yes, we could take all of the guidelines and incorporate them into the best practices section of the Top Navigation component, which would leave the labels section to address only Content Labels.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/rackerlabs/design-system/pull/536#discussion_r197261073, or mute the thread https://github.com/notifications/unsubscribe-auth/AE4ycvycIGC0_52jUJdIvns4zfFucDJEks5t-_0fgaJpZM4USSEm .

--

M. Barton Renner Experience Design & Interaction Design & Design Strategy @palindromebart https://twitter.com/PalindromeBart | bartrenner.com http://www.bartrenner.com

chri2547 commented 6 years ago

Maybe general writing guidelines?

From: "Bart Renner (Michael Barton Renner)" notifications@github.com Reply-To: rackerlabs/design-system reply@reply.github.com Date: Thursday, June 21, 2018 at 3:09 PM To: rackerlabs/design-system design-system@noreply.github.com Cc: Christopher Moyer Christopher.Moyer@rackspace.com, Assign assign@noreply.github.com Subject: COMMERCIAL: Re: [rackerlabs/design-system] Text conventions (#536)

does that make labels a subsection of another text conventions page then?

On Thu, Jun 21, 2018 at 3:07 PM, Christopher Moyer <notifications@github.com

wrote:

@chri2547 commented on this pull request.

In _docs/style/text-conventions/labels.md https://github.com/rackerlabs/design-system/pull/536#discussion_r197261073 :

+last-modified: 2018-06-01 +--- + +{% include toc.html %} + +

+ +
+ +{% column left:"hxCol-12 hxCol-xs-12 hxCol-sm-12 hxCol-md-12 hxCol-lg-12" %} + +## Menu labels + +A menu contains menu items that users use to navigate the pages of a control panel. + +Consider the following guidelines when labeling menu items:

Yes, we could take all of the guidelines and incorporate them into the best practices section of the Top Navigation component, which would leave the labels section to address only Content Labels.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/rackerlabs/design-system/pull/536#discussion_r197261073, or mute the thread https://github.com/notifications/unsubscribe-auth/AE4ycvycIGC0_52jUJdIvns4zfFucDJEks5t-_0fgaJpZM4USSEm .

--

M. Barton Renner Experience Design & Interaction Design & Design Strategy @palindromebart https://twitter.com/PalindromeBart | bartrenner.com http://www.bartrenner.com

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHubhttps://github.com/rackerlabs/design-system/pull/536#issuecomment-399227123, or mute the threadhttps://github.com/notifications/unsubscribe-auth/Ah0hun_6zpvmW4OI4p65R7_W1eq-Bisfks5t-_2IgaJpZM4USSEm.

palindromebart commented 6 years ago

agreed.

On Thu, Jun 21, 2018 at 3:14 PM, Christopher Moyer <notifications@github.com

wrote:

Maybe general writing guidelines?

From: "Bart Renner (Michael Barton Renner)" notifications@github.com Reply-To: rackerlabs/design-system reply@reply.github.com Date: Thursday, June 21, 2018 at 3:09 PM To: rackerlabs/design-system design-system@noreply.github.com Cc: Christopher Moyer Christopher.Moyer@rackspace.com, Assign < assign@noreply.github.com> Subject: COMMERCIAL: Re: [rackerlabs/design-system] Text conventions (#536)

does that make labels a subsection of another text conventions page then?

On Thu, Jun 21, 2018 at 3:07 PM, Christopher Moyer < notifications@github.com

wrote:

@chri2547 commented on this pull request.

In _docs/style/text-conventions/labels.md https://github.com/rackerlabs/design-system/pull/ 536#discussion_r197261073 :

+last-modified: 2018-06-01 +--- + +{% include toc.html %} + +

+ +
+ +{% column left:"hxCol-12 hxCol-xs-12 hxCol-sm-12 hxCol-md-12 hxCol-lg-12" %} + +## Menu labels + +A menu contains menu items that users use to navigate the pages of a control panel. + +Consider the following guidelines when labeling menu items:

Yes, we could take all of the guidelines and incorporate them into the best practices section of the Top Navigation component, which would leave the labels section to address only Content Labels.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/rackerlabs/design-system/pull/ 536#discussion_r197261073, or mute the thread https://github.com/notifications/unsubscribe-auth/AE4ycvycIGC0_ 52jUJdIvns4zfFucDJEks5t-_0fgaJpZM4USSEm .

--

M. Barton Renner Experience Design & Interaction Design & Design Strategy @palindromebart https://twitter.com/PalindromeBart | bartrenner.com http://www.bartrenner.com

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHubhttps://github.com/ rackerlabs/design-system/pull/536#issuecomment-399227123, or mute the threadhttps://github.com/notifications/unsubscribe- auth/Ah0hun_6zpvmW4OI4p65R7_W1eq-Bisfks5t-_2IgaJpZM4USSEm.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/rackerlabs/design-system/pull/536#issuecomment-399228241, or mute the thread https://github.com/notifications/unsubscribe-auth/AE4ycnf34m5CHw40LQiWm1QzbAQGB98Fks5t-_6OgaJpZM4USSEm .

--

M. Barton Renner Experience Design & Interaction Design & Design Strategy @palindromebart https://twitter.com/PalindromeBart | bartrenner.com http://www.bartrenner.com

chri2547 commented 6 years ago

So ordered and unordered lists are not forms of punctuation. Bullets and numbered lists are considered text styles.

We do have a story in the backlog that addresses text as a component that will include things like:

I wonder if we should lump all of those ‘stylistic’ elements of text, along with ordered and unordered lists into a section called “Text Style” or something?

In the meantime, we can go with lists as-is? Penny for your thoughts.

From: "Bart Renner (Michael Barton Renner)" notifications@github.com Reply-To: rackerlabs/design-system reply@reply.github.com Date: Thursday, June 21, 2018 at 4:05 PM To: rackerlabs/design-system design-system@noreply.github.com Cc: Christopher Moyer Christopher.Moyer@rackspace.com, Assign assign@noreply.github.com Subject: COMMERCIAL: Re: [rackerlabs/design-system] Text conventions (#536)

@palindromebart requested changes on this pull request.


In _docs/style/text-conventions/lists.mdhttps://github.com/rackerlabs/design-system/pull/536#discussion_r197272518:

@@ -0,0 +1,58 @@

+---

+title: Lists

Is this a form of punctuation? and thus belongs on the punctuation page?


In _docs/style/text-conventions/lists.mdhttps://github.com/rackerlabs/design-system/pull/536#discussion_r197273211:

+

+

+

+

+

+{% column left:"hxCol hxSpan-12-xs hxSpan-12-sm hxSpan-4-md hxSpan-4-lg" %}

+

+## Unordered lists

+

+Use unordered lists to group related items. Items in a list should share a similar level of importance. When possible, write bullet items to be approximately the same length. Keeping a uniform length is pleasing to the eye and makes the list more consumable to a user.

+

+{% endcolumn %}

+

+{% column right:"hxCol hxSpan-12-xs hxSpan-12-sm hxSpan-8-md hxSpan-8-lg" %}

+{% figure [class:"image bg-light border"] %}

+

image redlines for this section are out of date. need to be revised.

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHubhttps://github.com/rackerlabs/design-system/pull/536#pullrequestreview-130987142, or mute the threadhttps://github.com/notifications/unsubscribe-auth/Ah0hunkpB3aMoO0uonNaY_SI59b12bVPks5t_Ap_gaJpZM4USSEm.

chri2547 commented 6 years ago

Ok, I can work on that.

From: "Bart Renner (Michael Barton Renner)" notifications@github.com Reply-To: rackerlabs/design-system reply@reply.github.com Date: Thursday, June 21, 2018 at 3:17 PM To: rackerlabs/design-system design-system@noreply.github.com Cc: Christopher Moyer Christopher.Moyer@rackspace.com, Assign assign@noreply.github.com Subject: COMMERCIAL: Re: [rackerlabs/design-system] Text conventions (#536)

agreed.

On Thu, Jun 21, 2018 at 3:14 PM, Christopher Moyer <notifications@github.com

wrote:

Maybe general writing guidelines?

From: "Bart Renner (Michael Barton Renner)" notifications@github.com Reply-To: rackerlabs/design-system reply@reply.github.com Date: Thursday, June 21, 2018 at 3:09 PM To: rackerlabs/design-system design-system@noreply.github.com Cc: Christopher Moyer Christopher.Moyer@rackspace.com, Assign < assign@noreply.github.com> Subject: COMMERCIAL: Re: [rackerlabs/design-system] Text conventions (#536)

does that make labels a subsection of another text conventions page then?

On Thu, Jun 21, 2018 at 3:07 PM, Christopher Moyer < notifications@github.com

wrote:

@chri2547 commented on this pull request.

In _docs/style/text-conventions/labels.md https://github.com/rackerlabs/design-system/pull/ 536#discussion_r197261073 :

+last-modified: 2018-06-01 +--- + +{% include toc.html %} + +

+ +
+ +{% column left:"hxCol-12 hxCol-xs-12 hxCol-sm-12 hxCol-md-12 hxCol-lg-12" %} + +## Menu labels + +A menu contains menu items that users use to navigate the pages of a control panel. + +Consider the following guidelines when labeling menu items:

Yes, we could take all of the guidelines and incorporate them into the best practices section of the Top Navigation component, which would leave the labels section to address only Content Labels.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/rackerlabs/design-system/pull/ 536#discussion_r197261073, or mute the thread https://github.com/notifications/unsubscribe-auth/AE4ycvycIGC0_ 52jUJdIvns4zfFucDJEks5t-_0fgaJpZM4USSEm .

--

M. Barton Renner Experience Design & Interaction Design & Design Strategy @palindromebart https://twitter.com/PalindromeBart | bartrenner.com http://www.bartrenner.com

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHubhttps://github.com/ rackerlabs/design-system/pull/536#issuecomment-399227123, or mute the threadhttps://github.com/notifications/unsubscribe- auth/Ah0hun_6zpvmW4OI4p65R7_W1eq-Bisfks5t-_2IgaJpZM4USSEm.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/rackerlabs/design-system/pull/536#issuecomment-399228241, or mute the thread https://github.com/notifications/unsubscribe-auth/AE4ycnf34m5CHw40LQiWm1QzbAQGB98Fks5t-_6OgaJpZM4USSEm .

--

M. Barton Renner Experience Design & Interaction Design & Design Strategy @palindromebart https://twitter.com/PalindromeBart | bartrenner.com http://www.bartrenner.com

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHubhttps://github.com/rackerlabs/design-system/pull/536#issuecomment-399229096, or mute the threadhttps://github.com/notifications/unsubscribe-auth/Ah0huqGWB2jSRxPnsVvnrvyjZ131Er-Sks5t-_9OgaJpZM4USSEm.

palindromebart commented 6 years ago

sounds good to me. i would lump this lists content in with the other text styling you mentioned. and yes we can proceed for now. the visuals will need to be updted tho to make the redlines consistent with new standards.

On Thu, Jun 21, 2018 at 4:37 PM, Christopher Moyer <notifications@github.com

wrote:

So ordered and unordered lists are not forms of punctuation. Bullets and numbered lists are considered text styles.

We do have a story in the backlog that addresses text as a component that will include things like:

  • Text wrapping
  • Text size
  • Text shape (justification)
  • Text and icons
  • Etc.

I wonder if we should lump all of those ‘stylistic’ elements of text, along with ordered and unordered lists into a section called “Text Style” or something?

In the meantime, we can go with lists as-is? Penny for your thoughts.

From: "Bart Renner (Michael Barton Renner)" notifications@github.com Reply-To: rackerlabs/design-system reply@reply.github.com Date: Thursday, June 21, 2018 at 4:05 PM To: rackerlabs/design-system design-system@noreply.github.com Cc: Christopher Moyer Christopher.Moyer@rackspace.com, Assign < assign@noreply.github.com> Subject: COMMERCIAL: Re: [rackerlabs/design-system] Text conventions (#536)

@palindromebart requested changes on this pull request.


In _docs/style/text-conventions/lists.mdhttps://github.com/ rackerlabs/design-system/pull/536#discussion_r197272518:

@@ -0,0 +1,58 @@

+---

+title: Lists

Is this a form of punctuation? and thus belongs on the punctuation page?


In _docs/style/text-conventions/lists.mdhttps://github.com/ rackerlabs/design-system/pull/536#discussion_r197273211:

+

+

+

+

+

+{% column left:"hxCol hxSpan-12-xs hxSpan-12-sm hxSpan-4-md hxSpan-4-lg" %}

+

+## Unordered lists

+

+Use unordered lists to group related items. Items in a list should share a similar level of importance. When possible, write bullet items to be approximately the same length. Keeping a uniform length is pleasing to the eye and makes the list more consumable to a user.

+

+{% endcolumn %}

+

+{% column right:"hxCol hxSpan-12-xs hxSpan-12-sm hxSpan-8-md hxSpan-8-lg" %}

+{% figure [class:"image bg-light border"] %}

+

image redlines for this section are out of date. need to be revised.

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHubhttps://github.com/ rackerlabs/design-system/pull/536#pullrequestreview-130987142, or mute the threadhttps://github.com/notifications/unsubscribe- auth/Ah0hunkpB3aMoO0uonNaY_SI59b12bVPks5t_Ap_gaJpZM4USSEm.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/rackerlabs/design-system/pull/536#issuecomment-399251597, or mute the thread https://github.com/notifications/unsubscribe-auth/AE4ycqpFSoLwaiiMP7gAk4JlN2n-q81Wks5t_BINgaJpZM4USSEm .

--

M. Barton Renner Experience Design & Interaction Design & Design Strategy @palindromebart https://twitter.com/PalindromeBart | bartrenner.com http://www.bartrenner.com

cyrichardson commented 6 years ago

@chri2547 Suggested changes here: Helix-text-conventions_cyrEdits.docx

nimbinatus commented 6 years ago

@chri2547 tag me on a review when you're ready for me to review and merge, please? I can't tell whether the final content review has been finished.

nimbinatus commented 6 years ago

Re-requesting reviews. Currently have an outstanding question at https://github.com/rackerlabs/design-system/pull/536#discussion_r200463117