Discussion: files structure of a single package

daisy-ycguo commented 8 years ago

I think, we can put all related files of a single package in the package folder ( test files are not included ). A package folder shall contain:

source code files
README.md to describe actions/feeds in the package and how to invoke them
install.sh to install the package

If we agree with this proposal, we can:

move installCatalog.sh to the root folder
move installXXX.sh to each package folder.
make installCatalog.sh more dynamic, calling every install.sh under the sub folder of openwhisk-catalog/packages, other than hard coding the file name of every package install script.

Daisy

daisy-ycguo commented 8 years ago

We also need to think about the relationship between openwhisk-package-tempate and openwhisk-catalog. Shall we make them consistency ? If the file structure is consistency, a user's created package followed openwhisk-package-template can be easily contributed to openwhisk-catalog.

Daisy

mrutkows commented 8 years ago

Daisy has the correct idea; each package should be treated independently from the other and have a consistent set of files and structure (the directory structure changes as part of the move is the first step towards consistency). We will eventually have a manifest as well and and installer that uses the manifest. Having said that, we agreed to allow system and utils to have many actions in one directory as these are "built-ins" and we must be true to this agreement for now. The "samples" are another matter and each should be installable by themselves and each have a README (at least 1 per family). THis is what I was trying to ask David to do a month ago when he ran into overlapping work with another person re-writing READMEs so I had him stop at that time. If you recall, I asked him to have 1 README per unique sample and 1 README for utils and 1 README for system actions. He started at the top of the catalog and ran into another person working in the same file. Now that is no longer true we should look at this again.

houshengbo commented 8 years ago

I support the point of @daisy-ycguo's. Let's first get everything like the package and install script from openwhisk to this catalog. Make sure things are going fine and tested, able for openwhisk to switch. After that we can change the structure of the package one by one. Does it sound good? @daisy-ycguo @mrutkows @rabbah

houshengbo commented 8 years ago

@jasonpet I think this is the discussion raised about some refactoring of the file structure.

apache / openwhisk-catalog

Discussion: files structure of a single package #47