diff --git a/README.md b/README.md index ed7276fefe5ae72d28761b405dee3d0e97038fe6..a06d7c970cb3f7ec75c44e5a9a4013c89d77b2ed 100644 --- a/README.md +++ b/README.md @@ -1,134 +1,14 @@ # Community-theme -## Prérequis - -### Plugins - -Ce thème utilise les plugins ci-dessous, pensez à les installer avant d'installer ce thème. - -#### One year anniversary - -Lors des un an de votre post, recevez une notification pour repartager celui-ci à votre communauté. - -- Doc : https://meta.discourse.org/t/discourse-yearly-review-plugin/105713 -- Dépôt : https://github.com/discourse/discourse-yearly-review - -#### Reaction - -Ajoutez des émojis et participez de façon dynamique aux conversations. - -- Doc : https://meta.discourse.org/t/discourse-reactions-beyond-likes/183261 -- Dépôt : https://github.com/discourse/discourse-reactions - -#### Private topic to discover - -Vos contenus sont visibles partiellement : encouragez vos contacts à s'inscrire sur la plateforme pour voir la totalité des contenus. - -- Doc : https://meta.discourse.org/t/advertise-activity-in-a-private-category-discourse-category-lockdown/70649https://github.com/paviliondev/discourse-category-lockdown -- Dépôt : https://github.com/paviliondev/discourse-category-lockdown - -#### Problème du topic résolu - -Indiquez à une communauté le statut "résolu" d'un problème. - -- Doc : https://www.discourse.org/plugins/solved.html -- Dépôt : https://github.com/discourse/discourse-solved - -#### Automatisation (ex: for event) - -Automatisez des actions complexes (version beta). - -- Doc : https://meta.discourse.org/t/discourse-automation/195773 -- Dépôt : https://github.com/discourse/discourse-automation - -#### Follower - -Suivez, recevez des notifications de vos membres préférés et tenez vous au courant du nombre de followers. - -- Doc : https://meta.discourse.org/t/follow-plugin/110579 -- Dépôt : https://github.com/discourse/discourse-follow - -#### Calendrier - -Partagez des événement avec les autres membres sur votre calendrier, ou passez en mode "vacances". - -- Doc : https://meta.discourse.org/t/discourse-calendar/97376 -- Dépôt : https://github.com/discourse/discourse-calendar - -#### map and post - -Ajoutez votre géolocalisation sur vos post, ceux-ci peuvent favoriser les recherches entre membres. - -- Doc : https://meta.discourse.org/t/locations-plugin/69742 -- Dépôt : https://github.com/paviliondev/discourse-locations +Ce thème est inspiré du thème [**_Mint_**](https://meta.discourse.org/t/mint-a-modern-theme-for-discourse/202822). Il est dédié à la la gestion de communautés en ligne. -#### Location plugin - -Découvrez la carte des membres de votre communauté et organisez des événements avec les membres les plus proches. - -- Doc : https://meta.discourse.org/t/locations-plugin/69742/723 -- Dépôt : https://github.com/discourse/discourse-calendar - -### Composants - -Ce thème utilise les composants ci-dessous, pensez à les installer avant d'installer ce thème. - -#### Icônes pour les catégories - -Les catégories sont affichées avec des icônes complétant les titres. - -- Doc : https://meta.discourse.org/t/category-icons-component/104683 -- Dépôt : https://github.com/discourse/discourse-category-icons - -#### Discourse loading slider - -Une barre horizontale s'affiche lors du temps de chargement d'une page. - -- Doc : https://meta.discourse.org/t/experiment-on-meta-horizontal-loading-slider/177939 -- Dépôt : https://github.com/discourse/discourse-loading-slider - -#### Discourse category banners - -Affiche une barre de catégorie en haut de la page catégorie. - -- Doc : https://meta.discourse.org/t/discourse-category-banners/86241 -- Dépôt : https://github.com/discourse/discourse-category-banners.git - -#### Discourse search banner - -Affiche une barre de recherche sur la page d'accueil. - -- Doc : https://meta.discourse.org/t/search-banner-theme-component/122939 -- Dépôt : https://github.com/discourse/discourse-search-banner.git - -#### Easy footer - -Ajoute un _footer_ simple et responsive. - -- Doc : https://meta.discourse.org/t/easy-responsive-footer/95818 -- Dépôt : https://github.com/discourse/Discourse-easy-footer - -#### Icons header - -Permet d'ajouter des liens sur la partie "header" de votre site avec des icones. - -- Doc : https://meta.discourse.org/t/custom-header-links-icons/86307 -- Dépôt : https://github.com/discourse/discourse-icon-header-links - -#### MD Topic list - -Épuration de la partie page d'accueil en améliorant la charte initiale. - -- Doc : https://meta.discourse.org/t/md-topic-list-component/117694 -- Dépôts : https://github.com/MonDiscourse/md-topic-list - -#### TOC, Table of content +## Prérequis -Ajoute la table des matière du post. +Ce thème à besoin de composants et de plugins pour être pleinement fonctionnels, voir [la section des prérequis](doc/prerequis.md). -- Doc : https://meta.discourse.org/t/discotoc-automatic-table-of-contents/111143 -- Dépôts : https://github.com/discourse/DiscoTOC.git +## Configuration +Après l'installation du thème vous aurez besoin de le configurer correctement, voir [la section configuration](doc/configuration.md). ## Licence [](https://choosealicense.com/licenses/gpl-3.0/) diff --git a/README_theme.md b/README_theme.md deleted file mode 100644 index 36a02e281820b398b8f9b770e003631aa8d3f568..0000000000000000000000000000000000000000 --- a/README_theme.md +++ /dev/null @@ -1,87 +0,0 @@ -# Configuration du thème et des composants - -### Comment ça marche ? - -#### Thème de base - -Nous utilisons le thème **_Mint_** qui reprend les composants **_discourse-search-banner_** et **_Showcased Categories_**. -Nous avons apporté quelques modifications au thème **_Mint_**, afin d'en retirer des formes de décoration et le **_discourse-search-banner_**, ainsi qu'y mettre nos tons colorimétriques et certaines modifications liées aux composants. - -**Trois composants sont utilisés dans notre thème principal :** - -- _Versatile Banner_ -- _Categories boxes_ -- _Showcased Categories_ - -#### Bannière _How to begin ?_ - -D'après le composant **_Versatile Banner_**, nous récupérons les images d'après un url dans un groupe privée, accessible uniquement par l'admin ([plus d'info. ici](https://meta.discourse.org/t/upload-image-in-discourse/141504/4)). -- Doc : https://meta.discourse.org/t/versatile-banner/109133 -- Dépôt : https://github.com/tshenry/discourse-versatile-banner.git - -##### Configuration - -- Possibilité d'afficher cette fonctionnalité à tout le monde ou à un type d'utilisateur : membres, inconnus. -- Afficher la bannière sur les appareils mobiles, ordinateurs. -- Afficher la bannière sur la page d'accueil. -- Modification des images, des titres, sous-titres et textes, ainsi que du nombre de boxe (4 max). -- Choix des pages où apparaîtra la bannière. -- Autoriser les utilisateurs à masquer la bannière. -- Mettre un fond derrière les images. -- Changer les couleurs du texte. - -##### Notre configuration de base - -La bannière est inclue dans le thème. -La bannière s'affiche pour tout le monde et il est possible de la masquer mais pas de l'enlever. -Elle apparaît sur les pages : - -- `/latest` -- `/categories` -- `/new` -- `/unread` -- `/top*` -- `/tag/*` -- `/tags/*` -- `/c/*` -- `/t/*` - -Il n'y a pas de fond ni d'image de fond, il est néanmoins possible d'en ajouter. - -Ensuite on ajoute le contenu de la bannière : texte, images dans chaque colonnes. - -Afin d'ajouter une image dans la bannière, il faut récupérer son lien URL. Pour se faire, on créer un post avec une image dans la catégorie staff (privée). Le post ainsi créée, on affiche l'image et on y fait un clic droit pour "copier le lien de l'image". Puis, coller ce lien dans la page configuration du composant, section `Column Icons`. -Voir la page suivante : https://meta.discourse.org/t/upload-image-in-discourse/141504 - ---- -#### Categories boxes - -Nous partons du html du composant **_Categories Layout Override_**, et utilisons le scss d'un autre lien. - -- Doc Categories layout override : https://meta.discourse.org/t/categories-layout-override/131098 -- Dépôt : https://github.com/tshenry/discourse-categories-layout-override -- Doc et code scss : https://meta.discourse.org/t/how-to-change-categories-style/78067/14 - -Note : Des modifications ont été réalisé dans le scss. - -##### Notre configuration de base - -Les titres et sous-titres ne sont pas affichés grace à l'option `category-boxe`, et nous gardons uniquement les images et les titres des topics. - ---- -#### Category post - -Le composant **_Showcased Categories_** s'adapte d'office au thème général du forum. - -- Doc : https://meta.discourse.org/t/showcased-categories-theme-component/173524 -- Dépôt : https://github.com/discourse/discourse-showcased-categories.git - -##### Configuration - -Définir le thème de ce que constitura les deux boîtes. On défini la taille maximum du contenu des boîtes et de son contenu : _Latest_ et _Top_. - ---- - -#### Configuration générale après installation du thème - -Par défaut, des couleurs ont été appliqué mais vous pouvez les modifier votre palette de couleurs dans `Customize / Colors`. Pour faire valider le thème, celui-ci doit être votre **thème par défaut.** Dans la section `Included Components`, vous pouvez cliquer sur `Add all` ou bien n'en mettre que certains. diff --git a/doc/configuration.md b/doc/configuration.md new file mode 100644 index 0000000000000000000000000000000000000000..200281271bb387667d516bdc9406f51edb5098ae --- /dev/null +++ b/doc/configuration.md @@ -0,0 +1,68 @@ +# Configuration du thème et des composants + +## Comment ça marche ? + +### Configuration du thème + +Les couleurs par défaut peuvent être modifier avec votre palette de couleurs dans `Customize / Colors`. Pour plus d'information sur les palettes de couleurs [voir ici](https://meta.discourse.org/t/how-to-create-and-share-a-color-scheme/61196). + +**Trois composants sont utilisés dans notre thème :** + +- _Versatile Banner_ +- _Categories boxes_ +- _Showcased Categories_ + +### Bannière _How to begin ?_ + +C'est le composant **_Versatile Banner_** qui est utilisé pour cette banière. + +- Doc : https://meta.discourse.org/t/versatile-banner/109133 +- Dépôt : https://github.com/tshenry/discourse-versatile-banner.git + +#### Configuration + +La bannière s'affiche pour tout le monde et il est possible de la masquer mais pas de l'enlever. +Elle apparaît sur les pages : + +- `/latest` +- `/categories` +- `/new` +- `/unread` +- `/top*` +- `/tag/*` +- `/tags/*` +- `/c/*` +- `/t/*` + +Il n'y a pas de fond ni d'image de fond, il est néanmoins possible d'en ajouter. + +Ensuite il faut configuer le contenu de la bannière : texte, images dans chaque colonnes en ecrivant le code HTML. + +Pour personnaliser les images de la banière, il faut les ajouter dans la categorie accessible uniquement par [les responsables](https://meta.discourse.org/t/upload-image-in-discourse/141504/4). + +Pour se faire, créez un post avec une image dans la catégorie _staff_ (privée). parcourir le post créée qui affiche l'image et faite un clic droit pour **copier le lien de l'image**. Puis, coller ce lien dans la page configuration du composant, section `Column Icons`. +[Pour plus d'information voir ici](https://meta.discourse.org/t/upload-image-in-discourse/141504/4) + +--- + +### Categories boxes + +Ce composant est inspiré du composant **_Categories Layout Override_**. C'est luis qui affiche les boîtes de categories. + +- Doc : https://meta.discourse.org/t/categories-layout-override/131098 +- Dépôt : https://github.com/tshenry/discourse-categories-layout-override +- [ ] TODO mettre le lien de notre dépot + + +--- + +### Category post + +Le composant **_Showcased Categories_** présente deux boîtes avec une liste de 4 postes. + +- Doc : https://meta.discourse.org/t/showcased-categories-theme-component/173524 +- Dépôt : https://github.com/discourse/discourse-showcased-categories.git + +#### Configuration + +Défini la taille en nombre de post maximum du contenu des boîtes et les catégories qui seront dans les boites contenu : _Latest_ et _Top_. diff --git a/doc/prerequis.md b/doc/prerequis.md new file mode 100644 index 0000000000000000000000000000000000000000..102555a2608867d72a77376deb9cf44dea6e9d8a --- /dev/null +++ b/doc/prerequis.md @@ -0,0 +1,128 @@ +# Prérequis + +## Composants + +Ce thème utilise les composants ci-dessous, pensez à les installer avant d'installer ce thème. + +### Icônes pour les catégories + +Les catégories sont affichées avec des icônes complétant les titres. + +- Doc : https://meta.discourse.org/t/category-icons-component/104683 +- Dépôt : https://github.com/discourse/discourse-category-icons + +### Discourse loading slider + +Une barre horizontale s'affiche lors du temps de chargement d'une page. + +- Doc : https://meta.discourse.org/t/experiment-on-meta-horizontal-loading-slider/177939 +- Dépôt : https://github.com/discourse/discourse-loading-slider + +### Discourse category banners + +Affiche une barre de catégorie en haut de la page catégorie. + +- Doc : https://meta.discourse.org/t/discourse-category-banners/86241 +- Dépôt : https://github.com/discourse/discourse-category-banners.git + +### Discourse search banner + +Affiche une barre de recherche sur la page d'accueil. + +- Doc : https://meta.discourse.org/t/search-banner-theme-component/122939 +- Dépôt : https://github.com/discourse/discourse-search-banner.git + +### Easy footer + +Ajoute un _footer_ simple et responsive. + +- Doc : https://meta.discourse.org/t/easy-responsive-footer/95818 +- Dépôt : https://github.com/discourse/Discourse-easy-footer + +### Icons header + +Permet d'ajouter des liens sur la partie "header" de votre site avec des icones. + +- Doc : https://meta.discourse.org/t/custom-header-links-icons/86307 +- Dépôt : https://github.com/discourse/discourse-icon-header-links + +### MD Topic list + +Épuration de la partie page d'accueil en améliorant la charte initiale. + +- Doc : https://meta.discourse.org/t/md-topic-list-component/117694 +- Dépôts : https://github.com/MonDiscourse/md-topic-list + +### TOC, Table of content + +Ajoute la table des matière du post. + +- Doc : https://meta.discourse.org/t/discotoc-automatic-table-of-contents/111143 +- Dépôts : https://github.com/discourse/DiscoTOC.git + +## Plugins + +Pour une meilleur experience utilisateur nous vous conseillons aussi d'installer les plugins ci-dessous. + +### One year anniversary + +Lors des un an de votre post, recevez une notification pour repartager celui-ci à votre communauté. + +- Doc : https://meta.discourse.org/t/discourse-yearly-review-plugin/105713 +- Dépôt : https://github.com/discourse/discourse-yearly-review + +### Reaction + +Ajoutez des émojis et participez de façon dynamique aux conversations. + +- Doc : https://meta.discourse.org/t/discourse-reactions-beyond-likes/183261 +- Dépôt : https://github.com/discourse/discourse-reactions + +### Private topic to discover + +Vos contenus sont visibles partiellement : encouragez vos contacts à s'inscrire sur la plateforme pour voir la totalité des contenus. + +- Doc : https://meta.discourse.org/t/advertise-activity-in-a-private-category-discourse-category-lockdown/70649https://github.com/paviliondev/discourse-category-lockdown +- Dépôt : https://github.com/paviliondev/discourse-category-lockdown + +### Problème du topic résolu + +Indiquez à une communauté le statut "résolu" d'un problème. + +- Doc : https://www.discourse.org/plugins/solved.html +- Dépôt : https://github.com/discourse/discourse-solved + +### Automatisation (ex: for event) + +Automatisez des actions complexes (version beta). + +- Doc : https://meta.discourse.org/t/discourse-automation/195773 +- Dépôt : https://github.com/discourse/discourse-automation + +### Follower + +Suivez, recevez des notifications de vos membres préférés et tenez vous au courant du nombre de followers. + +- Doc : https://meta.discourse.org/t/follow-plugin/110579 +- Dépôt : https://github.com/discourse/discourse-follow + +### Calendrier + +Partagez des événement avec les autres membres sur votre calendrier, ou passez en mode "vacances". + +- Doc : https://meta.discourse.org/t/discourse-calendar/97376 +- Dépôt : https://github.com/discourse/discourse-calendar + +### map and post + +Ajoutez votre géolocalisation sur vos post, ceux-ci peuvent favoriser les recherches entre membres. + +- Doc : https://meta.discourse.org/t/locations-plugin/69742 +- Dépôt : https://github.com/paviliondev/discourse-locations + +### Location plugin + +Découvrez la carte des membres de votre communauté et organisez des événements avec les membres les plus proches. + +- Doc : https://meta.discourse.org/t/locations-plugin/69742/723 +- Dépôt : https://github.com/discourse/discourse-calendar