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

CSS tools are broken by the redesign #5392

Open
wbamberg opened this issue Mar 2, 2022 · 10 comments
Open

CSS tools are broken by the redesign #5392

wbamberg opened this issue Mar 2, 2022 · 10 comments
Labels
🐛 bug Something isn't working, or isn't working as expected effort: large This task is large effort. idle involves: Product Requires the attention of the Product team. needs decision from content lead p4 Not urgent, only if time allows redesign issues related to the new design

Comments

@wbamberg
Copy link
Collaborator

wbamberg commented Mar 2, 2022

These pages:
https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Backgrounds_and_Borders/Border-image_generator
https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Backgrounds_and_Borders/Box-shadow_generator
https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Colors/Color_picker_tool

...no longer fit in the space allocated to them in the page.

Long term these tools should (IMO) be supported in Yari directly, not hacked in as iframes embedding GitHub pages.

@github-actions github-actions bot added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Mar 2, 2022
@schalkneethling schalkneethling added p1 We will address this soon and will provide capacity from our team for it in the next few releases. 🐛 bug Something isn't working, or isn't working as expected and removed needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. labels Mar 2, 2022
@schalkneethling schalkneethling self-assigned this Mar 2, 2022
@schalkneethling schalkneethling added the redesign issues related to the new design label Mar 2, 2022
@schalkneethling
Copy link

Long term these tools should (IMO) be supported in Yari directly, not hacked in as iframes embedding GitHub pages.

That is definitely on the roadmap. I am going to look into this and see if we can at least improve the current situation. Thanks for filing @wbamberg

@schalkneethling schalkneethling removed their assignment Apr 12, 2022
@github-actions github-actions bot added the 🐌 idle Issues and PRs without recent activity. Flagged for maintainer follow-up. label May 19, 2022
@wbamberg
Copy link
Collaborator Author

Any update on this?

@caugner
Copy link
Contributor

caugner commented Oct 19, 2022

I looked into the issues:

  1. The Border-image generator can be fitted by (a) increasing the iframe height to 1260px (or 1240px after removing the padding-bottom from the body), and (b) reducing the width of the div#preview element, e.g. 243x243 like the subject:
    image
  2. The Box-shadow generator can be fitted by increasing the iframe height to 980px (or 960px after removing the margin-top from the body).
  3. The Color picker tool can not easily be fitted, but the best would probably to convert it from its 2-column layout into a single-column layout.

PS: The tools are located in mdn/css-examples.

@caugner caugner removed the p1 We will address this soon and will provide capacity from our team for it in the next few releases. label Oct 19, 2022
@caugner
Copy link
Contributor

caugner commented Oct 19, 2022

Long term these tools should (IMO) be supported in Yari directly, not hacked in as iframes embedding GitHub pages.

@wbamberg Can you elaborate what you mean by Yari supporting these tools directly?

@wbamberg
Copy link
Collaborator Author

wbamberg commented Oct 19, 2022

I mean that at the moment these are (architecturally and organizationally) part of content: they're implemented using the code sample mechanism and maintained by (technically) writers. But they are not code samples, they are features of a website.

So (for example):

  • they don't integrate nicely into the website design in any way (colors, fonts, layout)
  • they are constrained to have content width when they would work better full width (and potentially be responsive and work on smaller screen).
  • they're entirely big blocks of code, that ought to be maintained as code. Nobody in the content team has the knowledge to maintain them at the moment (see for instance Border-image generator should allow "auto" as a border-image-width value content#21582 which I doubt we are equipped to fix)

They should be treated as purely part of the website, like the homepage or the search page, maintained by engineers within Yari and presented to users as tools, not content pages. Look at how w3schools has a link to a color picker on every page, presented as a separate thing from content pages. And the picker is integrated properly into the site's design, and is responsive on smaller screens. It's so much better than what we have.

(I should add that they were IIRC done a long time ago by a GSOC person under @teoli2003 's supervision, and the person did a really great job IMO)

@Rumyra
Copy link
Contributor

Rumyra commented Nov 4, 2022

There is a consensus to keep these around - I believe @schalkneethling suggested the following:

  • Copy from content
  • Update
  • Add to a separate repo where they can be served statically
  • Remove from content and update links

How does that sound?

@wbamberg
Copy link
Collaborator Author

wbamberg commented Nov 9, 2022

There is a consensus to keep these around - I believe @schalkneethling suggested the following:

  • Copy from content

  • Update

  • Add to a separate repo where they can be served statically

  • Remove from content and update links

How does that sound?

I'm not sure I understand this plan. The tools are already in a separate repo (at least, separate from mdn/content) - I moved them into css-examples when we markdownified MDN. When we say "Add to a separate repo where they can be served statically" - served how? As GH pages? But they are already GH pages.

Personally, as I said above, I think they should be part of yari, since otherwise it is hard to integrate them into the website design (for example, having good contrasting colours or making it responsive). But if we don't want to do that, I'm not sure how much it matters whether they are in css-examples or some other repo.

I'm not sure what "update" covers. Does it mean, fixing the breakage reported in this issue and in mdn/css-examples#157? Does it also mean making them responsive and making the color scheme work with the MDN themes? I suppose the main thing there is to have the resources to do this work.

So I suppose there are really three options?

  1. do nothing/retire them
  2. make them part of Yari
  3. keep them in a separate repo, built as GitHub pages, but find the time to update them so they aren't broken

So is the plan (3)? That would be OK. Certainly better than where we are now.

@Rumyra
Copy link
Contributor

Rumyra commented Nov 15, 2022

Yes pretty much @wbamberg - @schalkneethling I believe suggested finding community members who would like to practise their coding to update, whilst that might be the long game, I do like the idea

@caugner caugner added the p4 Not urgent, only if time allows label Nov 15, 2022
@github-actions github-actions bot removed the 🐌 idle Issues and PRs without recent activity. Flagged for maintainer follow-up. label Nov 15, 2022
@github-actions github-actions bot added the idle label Dec 21, 2022
estelle added a commit to estelle/yari that referenced this issue Nov 14, 2023
The four tools aren't maintained, responsive, or necessary, and some don't work. We shouldn't be hilighting them until they're fixed.

see:
* https://github.com/mdn/content/issues/21987 
(* mdn#5392
@estelle
Copy link
Member

estelle commented Nov 15, 2023

I submitted a PR to remove the tools from the sidebar; I don't think we should be promoting the tools until the issues addressed in this PR are addressed.

Note: there are some issues in css-examples for the border-image tool

@github-actions github-actions bot removed the idle label Jun 25, 2024
@github-actions github-actions bot added the idle label Jul 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛 bug Something isn't working, or isn't working as expected effort: large This task is large effort. idle involves: Product Requires the attention of the Product team. needs decision from content lead p4 Not urgent, only if time allows redesign issues related to the new design
Projects
Development

No branches or pull requests

5 participants