Metadata
- Source
- FLUID-5217
- Type
- Improvement
- Priority
- Blocker
- Status
- Closed
- Resolution
- Fixed
- Assignee
- Justin Obara
- Reporter
- Anastasia Cheetham
- Created
2013-11-20T11:15:51.068-0500 - Updated
2015-06-26T10:06:14.174-0400 - Versions
- N/A
- Fixed Versions
-
- 1.9
- Component
-
- Demos
Description
Currently, the 'demos' folder is contained inside the 'src' folder. I notice in the GPII prefsEditor repository (https://github.com/GPII/prefsEditors) that the 'demos' folder is a sibling of 'src,' and this seems to make a lot of sense to me. I suggest that we do the same for infusion demos.
We should also consider this in light of FLUID-5215 – the creation of instructional demos – and consider what the demos structure might be: demos and instructionalDemos as siblings to src, or showcaseDemos and instructionalDemos, or demos/showcase and demos/instructional, etc.
Note: There's a chance that this change might reveal bugs in our components where path assumptions are being made and we're simply unaware of it because the assumptions happen to be consistent with the existing relative paths between the demos and the source.
Comments
-
Anastasia Cheetham commented
2013-11-20T11:19:05.101-0500 Justin pointed out that this restructuring could be a factor for the build scripts, too.
-
Anastasia Cheetham commented
2013-11-20T16:30:20.292-0500 See the comment on FLUID-5215 for how we decided to restructure things
-
Anastasia Cheetham commented
2013-11-21T13:22:07.459-0500 Also, this change will affect the build site(s) that link to the demos folder, i.e. the link on build.fluidproject.org currently links to http://build.fluidproject.org/infusion/demos/ – that will have to change to http://build.fluidproject.org/infusion/demos/showcase/
Likewise, http://fluidproject.org/products/infusion/ has a link to http://fluidproject.org/products/infusion/infusion-demos which redirects to http://fluidproject.org/releases/1.4/demos/ – that will have to redirect to http://fluidproject.org/releases/1.5/demos/showcase after the release
-
Anastasia Cheetham commented
2013-11-27T17:01:31.643-0500 In progress, at https://github.com/acheetham/infusion/tree/FLUID-5217
So far, showcase and standalone demos moved, and tests moved.Build scripts seem broken (wrt demos and tests) even in master, so not yet addressed in this branch.
-
Anastasia Cheetham commented
2013-12-03T16:26:24.775-0500 Pull request issued: https://github.com/fluid-project/infusion/pull/444
-
Anastasia Cheetham commented
2014-03-26T15:33:39.364-0400 This will need to be redone, and we'll want to do it as the very last thing, after all other changes have been merged in.
-
Justin Obara commented
2014-05-28T15:47:01.794-0400 In talking at the community meeting today the recommendation was to move all the demos directories, lib and tests to be siblings of source. The built version should remain the same. However, we could not decide how to best reorganize the various demos.
-
Justin Obara commented
2014-05-29T08:55:27.543-0400 Discussion on the fluid-work mailing list
http://fluid.2324889.n4.nabble.com/Directory-restructuring-on-hold-td9046.html -
Justin Obara commented
2014-06-19T09:25:13.481-0400 We talked in detail about this at the community meeting yesterday. Anastasia forwarded the notes to the mailing list.
http://fluid.2324889.n4.nabble.com/Documentation-decisions-td9105.html -
Anastasia Cheetham commented
2014-06-19T10:22:17.990-0400 Here's my understanding of the new folder hierarchy resulting from yesterday's discussions:
src/
framework/
components/
lib/
module/
demos/
examples/
tests/For the demos and tests folder, their hierarchies will remain pretty much what they are now, except for: Within the tests folder, the manual-tests content will be renamed or otherwise organized to make it more clear which components are being tested. This might involve the creation of folders.
For the examples folder, the hierarchy should mirror, as much as reasonable, the hierarchy of the source folder. In general:
examples/
framework/
core/
prefs/
renderer/
components/
componentX/
shared/
css/
shared.css
html/
shared.html
js/
shared.js
demoX/
css/
file.css
html/
file.html
js/
file.js
demoY/
css/
file.css
html/
file.html
js/
file.js
componentY/
etc.. -
Justin Obara commented
2014-06-26T11:08:47.106-0400 Submitted a pull request:
https://github.com/fluid-project/infusion/pull/539 -
Cindy Li commented
2014-07-10T10:01:43.488-0400 Merged into the project repo @ 78593a2af5d62fe724404d9f5585a85c5c90ca9f
-
Justin Obara commented
2014-07-10T15:34:56.971-0400 the path to the tests directory in the devIncludes.json file in the module directory needs to be updated to point at the tests dir which has moved up a level.
-
Justin Obara commented
2014-07-10T15:36:10.968-0400 Filed another pull request to fix the devIncludes.json file
https://github.com/fluid-project/infusion/pull/543 -
Justin Obara commented
2014-07-11T08:48:47.997-0400 Pull request ( https://github.com/fluid-project/infusion/pull/543 ) was merged at 63d7180d3825fe572c0c08e6d89d61f6b3e2b7e7
-
Justin Obara commented
2014-07-11T10:51:10.492-0400 Pull request ( https://github.com/fluid-project/build.fluidproject.org/pull/11 ) has been merged to update the build site links at 920ce6e90808d70ce021db761610e8610d1c56f3
-
Justin Obara commented
2015-06-26T09:51:10.938-0400 Reopening to change the fix version to 1.9