Opened 7 years ago

Closed 3 years ago

#14834 closed task (patchwelcome)

Demos should use package.json

Reported by: Kitson Kelly Owned by: Kitson Kelly
Priority: low Milestone: 1.13
Component: Documentation Version: 1.7.2
Keywords: Cc:
Blocked By: Blocking:

Description

Instead of the /demos being built off of parsing README files, they should be converted to use CommonJS package.json.

We should also consider adding a build profile to each one as well.

It is something I will likely try to contribute in the future, so I am comfortable if you assign the ticket to me.

Change History (5)

comment:1 Changed 7 years ago by bill

Owner: set to Kitson Kelly
Status: newassigned

I thought we already had a profile: demos-all.profile? But I'll assign to you, I'm sure some improvement is possible, probably each demo should have it's own profile.

And I'm not familiar with how demos are built at all, so I'll take your word for that.

comment:2 Changed 7 years ago by Kitson Kelly

Yes, while there is a demo.profile.js and a package.json for the whole suite, neither of them are very specific and the demos.php, which generates the demos page on the website, parses a file called README in each demo directory to figure out what to display, when, in my opinion, each demo should have its own profile and package.json and we should deprecate the README to drive the whole process.

comment:3 Changed 7 years ago by Kitson Kelly

Priority: undecidedlow

comment:4 Changed 7 years ago by Kitson Kelly

Milestone: tbdfuture

comment:5 Changed 3 years ago by dylan

Milestone: future1.12
Resolution: patchwelcome
Status: assignedclosed

Given that no one has shown interest in creating a patch in the past 3+ years, I'm closing this as patchwelcome.

Note: See TracTickets for help on using tickets.