Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: rebranding docs #1856

Merged
merged 6 commits into from
Sep 18, 2024
Merged

feat: rebranding docs #1856

merged 6 commits into from
Sep 18, 2024

Conversation

tblivet
Copy link

@tblivet tblivet commented Aug 7, 2024

Questions Answers
Branch? 9.x
Description? Docs for BO rebranding
Fixed ticket?

feat: rebranding WIP
@kpodemski
Copy link
Contributor

kpodemski commented Aug 9, 2024

Hello @tblivet @jolelievre

Part of this content looks like it should be shared on the Build Blog, and another part looks like something we should put in "Notable changes" in the documentation, some is a generic information about CSS variables and something that could be part of the PrestaShop UI Kit repo only. I see three items:

First

Files:

  • development/rebranding/themes.md
  • development/rebranding/ui-kit-v2/why.md
  • development/rebranding/ui-kit-v2/css-variables.md

are good material for an article on the build blog or to the "second" point on this list.

Second

Files:

  • development/rebranding/ui-kit-v2/variables-reference.md
  • development/rebranding/ui-kit-v2/how-to-use-it.md
  • development/rebranding/ui-kit-v2/css-variables.md

are good content for https://devdocs.prestashop-project.org/8/development/uikit/

Third

Files:

  • development/rebranding/introduction.md
  • development/rebranding/breaking-changes.md

Something that should go to the Notable Changes.

Let me know what you think. I'm not insisting on having an article on the build blog, but "Why" and "How we did it" should be inside UI Kit section and linked from the Notable changes :)

title: Back office rebranding
weight: 60
chapter: true
useMermaid: true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no need to load mermaid if you don't use mermaid 😎

@tblivet
Copy link
Author

tblivet commented Aug 23, 2024

Hi @kpodemski and @jolelievre,
Based on your comments and other feedback, I have made some changes to make the documentation less narrative and more technical. I will include more narrative content in a separate blog post, as you suggested. I agree, it's a good idea to provide information in a post.

Copy link
Contributor

@kpodemski kpodemski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's the review. I added some suggestions.

@@ -0,0 +1,27 @@
---
title: BO rebranding
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can put this content inside the Notable Changes page that already exists:
https://devdocs.prestashop-project.org/9/modules/core-updates/9.0/

You can create a new section, "Back office rebranding", at the end of this page.

@@ -0,0 +1,20 @@
---
title: BO breaking changes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This content should be part of the existing notable changes page.

@@ -0,0 +1,12 @@
---
title: Core changes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not needed page.

@@ -1,6 +1,6 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you need to leave this page and create an alias, so that the old page will point to the new page.

weight: 64
---

# Introducing CSS variables
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Introducing CSS variables
# CSS variables in PrestaShop UI Kit

@@ -0,0 +1,55 @@
---
title: How to use it ?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
title: How to use it ?
title: How to use it?


# How to use new set of CSS variables ?

To maintain consistency across the PrestaShop back office, CSS variables have been introduced in `_root.scss`. This guide explains how to use these variables in PrestaShop.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To maintain consistency across the PrestaShop back office, CSS variables have been introduced in `_root.scss`. This guide explains how to use these variables in PrestaShop.
To maintain consistency across the PrestaShop back office, CSS variables have been introduced in `_root.scss`. This guide explains how to use them.


To maintain consistency across the PrestaShop back office, CSS variables have been introduced in `_root.scss`. This guide explains how to use these variables in PrestaShop.

## Using CSS variables with v9 and higher
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Using CSS variables with v9 and higher
## Using CSS variables in PrestaShop 9.0+


## Using CSS variables with v9 and higher

In PrestaShop v9 and higher, use the CSS variables introduced in `_root.scss` for consistent styling in the Back Office.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In PrestaShop v9 and higher, use the CSS variables introduced in `_root.scss` for consistent styling in the Back Office.
In PrestaShop v9 and later, we use the CSS variables introduced in `_root.scss` for consistent styling in the back office.

**Note:**

- `--cdk-primary-800` is a CSS variable defined in `_root.scss`. It ensures consistent color application across the back office.
- Refer to `_root.scss` for the latest <a href="https://github.com/PrestaShop/prestashop-ui-kit/blob/develop/scss/_root.scss" target="_blank">list of available variables</a>.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here I think you should use refrel to the docs page you created, right?

@tblivet
Copy link
Author

tblivet commented Sep 16, 2024

Hi @kpodemski, I have just added your suggestions. Is it okay for you?

@kpodemski
Copy link
Contributor

love it, thank you @tblivet !

@kpodemski kpodemski merged commit 2e5f1a8 into PrestaShop:9.x Sep 18, 2024
2 checks passed
@matks
Copy link
Contributor

matks commented Sep 18, 2024

Thank you @tblivet 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document the changes introduced by the v9 new branding
4 participants