Using kebab style for attachment names for xwiki.org

Development
,
1

Hello everyone,

As a follow-up to the proposals Page Names and Image Names regarding the use of kebab-case for page and attachment naming, the proposal is to apply kebab-case consistently across xwiki.org.

The use of kebab-case for page names has already been agreed for both documentation space and xwiki.org. Similarly, the use of kebab-case for attachment names has been agreed for documentation only, and it is now proposed, for consistency, to extend this rule to attachments across the entire xwiki.org

For now, the migration strategy will be as follows:

  • Start by migrating all attachments inside the new documentation space.
  • Every new attachment added to xwiki.org will follow the kebab-case naming convention.

WYT?

Thanks!

2

LGTM, we need that for consistency of URLs since the attachment names appear in the URL.

3

+1 from me.

Do we have a plan to add a documentation validation step for these names? It could help with maintenance.

Thanks!
Lucas C.

1 Like
4

Yes, it is planned to have checks for page names and attachments to use kebab-case: see the Design Page: https://design.xwiki.org/xwiki/bin/view/Proposal/DocumentationApplication#HChecks.

Thanks!

5

+1 as well, thanks

6

We need to implement Loading...

EDIT: And FTR we also need to implement:

7

+1

Thanks,
Marius

8

+1

Thanks,
Alex

9

+1

10

Thank you all for the replies!

The status for this is: Vincent, Eleni, Lucas, Manuel, Marius, Alex, Thomas: +1, so I’d say it’s been agreed.

We can now proceed with this.