Merge branch 'release/6.0.0' into 6.x

StadGent · Dec 19, 2024 · 748b17b · 748b17b
2 parents 932fadf + 1bdb06e
commit 748b17b
Show file tree

Hide file tree

Showing 10 changed files with 583 additions and 286 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,21 +3,21 @@
 All notable changes to this style guide are documented here.
 
 
-## [6.x-dev unreleased]
+## [6.0.0]
 
-* New Stad Gent style. View all markup changes below. Always look up
-the mentioned elements in the styleguide to see the new HTML markup.
+**New Stad Gent style. View all markup changes below. Always look up
+the mentioned elements in the styleguide to see the new HTML markup.**
 
-## New mixins
+## Added
 
-### theme-body()
+### theme-body() (mixin)
 
 The themify `theme()` function creates style selectors like this:
 ```css
 .cs--blue .original-selector .child ... {}
 ```
 
-Where cs--blue is the theme color and that class is added to the <body> element.
+Where `.cs--blue` is the theme color and this class is added to the <body> element.
 
 But sometimes the `.original-selector` is a body class which is not supported by
 the `theme()` function.
@@ -27,23 +27,25 @@ selector:
 .cs--blue.original-selector .child ... {}
 ```
 
-### Accolade element
+### Accolade element (mixin)
 `@include accolade;`
 
 Add an outside accolade to an element and add a color to it.
 
-### Abstract shadow
+### Abstract shadow (mixin)
 `@include abstract-shadow;`
 
 Add an underlying container of the same size under the chosen element.
 For example the highlight molecule.
 
-### Icon-right
+### Icon-right (mixin)
 `@include button-icon-right;`
 
 Also added the `.icon-right` class for icons that are on the right-hand side.
 
-## HTML markup changes
+## Changed (HTML markup)
+**Follow these markup changes in your project to have CSS applied flawlessly.**
+
 ### Legends
 **Added legend-title class**
 The legend now has a `<span class="legend-title">` around the text/title/label
@@ -58,7 +60,7 @@ Changed `<input>` to `<button>`. This is important to be able to use the hover e
 education, environment, for-children, fullscreen-enter, fullscreen-exit, ghent,
 health, info-circle, layers, link, living, map, mobility, music, next, pause,
 pinterest, play, previous, question, question-circle, refresh, settings,
-shopping, sign-language, spoken-language, stop, tag, target, threads, uitpas, 
+shopping, sign-language, sign-out, spoken-language, stop, tag, target, threads, uitpas, 
 uit-met-vlieg, view-grid, view-list, virus, whatsapp, wheelchair-no, work.
 
 Some icons have been updated, using the same machine name.
@@ -161,7 +163,6 @@ Becomes
 <span>Show all photos <i class="icon-fullscreen-enter" aria-hidden="true"></i></span>
 ```
 
-
 ### Contact details organism
 Not based on Highlight molecule anymore.
 The HTML markup has been simplified.
@@ -174,7 +175,6 @@ The links get a `no-icon` class.
 
 Add the `.contact-details--with-image` class to the contact-details section if you want to remove the side margins and set it to full width.
 
-
 ### Footer organism
 * Titles become `h4` except Gentinfo title stays `h3`.
 * `gentinfo-block` class gets 2nd class `dark-background`.
@@ -188,16 +188,17 @@ Add the `.contact-details--with-image` class to the contact-details section if y
 * The newsletter block does not use highlight block anymore, instead it uses the
   new feature-block markup.
 
-
 ### Filter layout
 * "You have selected" and "Found results" is normal text instead of `h2`.
 * The left sidebar title changed from `h2` to `h3`.
 
+
 ## [5.x and older]
 
 * See full changelog at
   https://github.com/StadGent/fractal_styleguide_gent-base/blob/5.x/CHANGELOG.md
 
 
 [6.x-dev unreleased]: https://github.com/StadGent/fractal_styleguide_gent-base/compare/6.x...6.x-dev
+[6.0.0]: https://github.com/StadGent/fractal_styleguide_gent-base/compare/5.1.7...6.0.0
 [5.x and older]: https://github.com/StadGent/fractal_styleguide_gent-base/compare/5.x...6.x
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -11,7 +11,7 @@ ways to help out, even if you've never worked on an open source project before.
 
 > Note that the development of this style guide is not done here. So
 > please do not create any pull requests directly here.
-> Instead use [this repo](https://github.com/digipolisgent/drupal_theme_gent-base)
+> Instead use [this repo](https://github.com/StadGent/drupal_theme_gent-base)
 > to create your pull requests.
 
 If you've found a bug or want to request a feature, you can report it by
@@ -32,7 +32,7 @@ following checklist:
 * **FILL IN ALL THE FIELDS ASKED FOR**
 * Search through existing issues (*including closed issues!*) first: you might
   be able to get your answer there.
-* Double check your issue manually, because it could be an external issue.
+* Double-check your issue manually, because it could be an external issue.
 * What providers are you using?
 * If you post logs, please use pastebin or github gist to store them!
 * Give a short step by step of how to reproduce the error.

diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Styleguide Gent Base
 
 This style guide contains the SASS library and needed assets to be able to style
-a web application in the corporate identity for the City of Ghent..
+a web application in the corporate identity for the City of Ghent.
 
 [![NPM version](https://img.shields.io/npm/v/gent_styleguide.svg)](https://www.npmjs.com/package/gent_styleguide)
 [![Downloads](https://img.shields.io/npm/dt/gent_styleguide.svg)](https://www.npmjs.com/package/gent_styleguide)

diff --git a/components/21-atoms/icon/icon.config.js b/components/21-atoms/icon/icon.config.js
@@ -96,6 +96,7 @@ const icons = [
   'share',
   'shopping',
   'sign-language',
+  'sign-out',
   'size',
   'spoken-language',
   'sportclub',

diff --git a/docs/01-index.md b/docs/01-index.md
@@ -1,17 +1,8 @@
 # City of Ghent Style Guide
 
----
-⚠️️ **NOTE VERSION 6**
-
-Version 6 is in a far progressed beta stage. Keep in mind minor changes can
-occur in future updates.
-Check the Github page mentioned below for updates until the first stable version 6.
-
----
-
 ## Versioning and releases
 
-We plan biannual releases, please see our
+We plan continuous releases with improvements, please see our
 [versioning and releases page]({{path '/docs/versioning-and-releases'}}) for details.  
 The changelog is available through our [GitHub repo](https://github.com/StadGent/fractal_styleguide_gent-base/)
 or on our [changelog page]({{path '/docs/changelog'}}).  

diff --git a/docs/05-versioning-and-releases.md b/docs/05-versioning-and-releases.md
@@ -11,7 +11,7 @@ _major.minor.patch_
 
 * **Major releases** may contain breaking changes, it will almost always be necessary to refactor some of your templates
   and check for usage of deprecated components and/or classNames.
-* **Minor releases** can contain new components, or non breaking changes.
+* **Minor releases** can contain new components, or non-breaking changes.
   These are changes where the HTML template remains the same, but the scss may have been updated.  
   If your project does not override our scss, there will be no impact.  
   If it does, you will have to update your scss accordingly.
@@ -21,10 +21,9 @@ For minor and major versions, please always check the [changelog]({{path '/docs/
 
 ## Release frequency
 
-We strive for a **major release every six months**. This should enable us to keep up to date with the
-style guide and expectations of the city. While also allowing developers and projects to plan their biannual updates.
-
-Major releases are planned for the **beginning of October and the beginning of April**.
+Patch and minor releases will be rolled out continuously. This should enable us to keep up to date with the
+style guide and expectations of the city.
+A major release would mean major changes or a change of style in general.
 
 ## Deprecation practices
 
@@ -34,5 +33,3 @@ This gives you 18 months to update your projects.
 
 For instance: the component `checkbox with filter` has been marked deprecated in version 4.0.0 (October 2020)
 and will be permanently removed in version 7.0.0 (April 2022).
-
-
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -3,21 +3,21 @@
 All notable changes to this style guide are documented here.
 
 
-## [6.x-dev unreleased]
+## [6.0.0]
 
-* New Stad Gent style. View all markup changes below. Always look up
-the mentioned elements in the styleguide to see the new HTML markup.
+**New Stad Gent style. View all markup changes below. Always look up
+the mentioned elements in the styleguide to see the new HTML markup.**
 
-## New mixins
+## Added
 
-### theme-body()
+### theme-body() (mixin)
 
 The themify `theme()` function creates style selectors like this:
 ```css
 .cs--blue .original-selector .child ... {}
 ```
 
-Where cs--blue is the theme color and that class is added to the <body> element.
+Where `.cs--blue` is the theme color and this class is added to the <body> element.
 
 But sometimes the `.original-selector` is a body class which is not supported by
 the `theme()` function.
@@ -27,23 +27,25 @@ selector:
 .cs--blue.original-selector .child ... {}
 ```
 
-### Accolade element
+### Accolade element (mixin)
 `@include accolade;`
 
 Add an outside accolade to an element and add a color to it.
 
-### Abstract shadow
+### Abstract shadow (mixin)
 `@include abstract-shadow;`
 
 Add an underlying container of the same size under the chosen element.
 For example the highlight molecule.
 
-### Icon-right
+### Icon-right (mixin)
 `@include button-icon-right;`
 
 Also added the `.icon-right` class for icons that are on the right-hand side.
 
-## HTML markup changes
+## Changed (HTML markup)
+**Follow these markup changes in your project to have CSS applied flawlessly.**
+
 ### Legends
 **Added legend-title class**
 The legend now has a `<span class="legend-title">` around the text/title/label
@@ -58,7 +60,7 @@ Changed `<input>` to `<button>`. This is important to be able to use the hover e
 education, environment, for-children, fullscreen-enter, fullscreen-exit, ghent,
 health, info-circle, layers, link, living, map, mobility, music, next, pause,
 pinterest, play, previous, question, question-circle, refresh, settings,
-shopping, sign-language, spoken-language, stop, tag, target, threads, uitpas, 
+shopping, sign-language, sign-out, spoken-language, stop, tag, target, threads, uitpas, 
 uit-met-vlieg, view-grid, view-list, virus, whatsapp, wheelchair-no, work.
 
 Some icons have been updated, using the same machine name.
@@ -161,7 +163,6 @@ Becomes
 <span>Show all photos <i class="icon-fullscreen-enter" aria-hidden="true"></i></span>
 ```
 
-
 ### Contact details organism
 Not based on Highlight molecule anymore.
 The HTML markup has been simplified.
@@ -174,7 +175,6 @@ The links get a `no-icon` class.
 
 Add the `.contact-details--with-image` class to the contact-details section if you want to remove the side margins and set it to full width.
 
-
 ### Footer organism
 * Titles become `h4` except Gentinfo title stays `h3`.
 * `gentinfo-block` class gets 2nd class `dark-background`.
@@ -188,16 +188,17 @@ Add the `.contact-details--with-image` class to the contact-details section if y
 * The newsletter block does not use highlight block anymore, instead it uses the
   new feature-block markup.
 
-
 ### Filter layout
 * "You have selected" and "Found results" is normal text instead of `h2`.
 * The left sidebar title changed from `h2` to `h3`.
 
+
 ## [5.x and older]
 
 * See full changelog at
   https://github.com/StadGent/fractal_styleguide_gent-base/blob/5.x/CHANGELOG.md
 
 
 [6.x-dev unreleased]: https://github.com/StadGent/fractal_styleguide_gent-base/compare/6.x...6.x-dev
+[6.0.0]: https://github.com/StadGent/fractal_styleguide_gent-base/compare/5.1.7...6.0.0
 [5.x and older]: https://github.com/StadGent/fractal_styleguide_gent-base/compare/5.x...6.x