Sprints: CSS Functional Notations - New URL Naming Convention

Created on 31 Oct 2020  Â·  13Comments  Â·  Source: mdn/sprints

URL(s)

All the articles in:

https://wiki.developer.mozilla.org/en-US/docs/Web/CSS/CSS_Functionals

Request type

  • [ ] New documentation
  • [x] Correction or update

Details

In https://github.com/mdn/sprints/issues/3838 we created an index of over 100 CSS functions. And I'm sure there are many more functions I've missed. But the important thing is that now we have a page listing all the CSS functions.

While working on this page I've noticed that some functions use the same name as data-types and/or pseudo elements/classes. I think we need to adopt a new naming convention for CSS functions on MDN to distinguish them from other articles. Basically changing the URLs.

Example:

https://wiki.developer.mozilla.org/en-US/docs/Web/CSS/image
https://wiki.developer.mozilla.org/en-US/docs/Web/CSS/imagefunction ( should be image() instead of imagefunction )

both links above represent an image. The first is image data-type, the second is an image() function. My proposal is to rename all the function URLs to include brackets (), like this article:

https://wiki.developer.mozilla.org/en-US/docs/Web/CSS/url() (the URL ends with () as this is a function article)

URL Naming Conventions:

CSS

All 13 comments

Reviewed. I've made a few tweaks, moved the page to https://wiki.developer.mozilla.org/en-US/docs/Web/CSS/CSS_Functions, and added the sidebar, but overall looks like a great start!

@ramiy I've moved these pages to the new URLs (and all of their translations).

My justification here is that this sems to be what we've done in the past — it's the closest we have to the convention right now — and I think it makes sense to have these consistent.

If we decide later on that we want to do something else, then it'll be trivial to do a mass edit and change them once the Yari platform goes live.

@chrisdavidmills You moved only 3 URLs, there are 56 more functions at:

https://wiki.developer.mozilla.org/en-US/docs/Web/CSS/CSS_Functions#Index

As for Yari, you can do it using the new CLI. But I'm not sure it's ready yet. Check the CSS folder it's not updated yet.

In any case, ping when you finish. I need to change to new URLs in all the articles.

@ramiy I'll have to do this another day. In the current wiki system, moving pages takes a long time; moving the other 53 function pages and all their translations would take a good few hours.

This is one reason why I am so excited about Yari! ;-)

@chrisdavidmills

Great work Chris, now we need to fix #3885

Was this page helpful?
0 / 5 - 0 ratings

Related issues

Elchi3 picture Elchi3  Â·  8Comments

EduardoPazz picture EduardoPazz  Â·  3Comments

ramiy picture ramiy  Â·  6Comments

ExE-Boss picture ExE-Boss  Â·  3Comments

bershanskiy picture bershanskiy  Â·  4Comments