Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New templates #28

Merged
merged 2 commits into from
Jun 6, 2019
Merged

New templates #28

merged 2 commits into from
Jun 6, 2019

Conversation

rokroskar
Copy link
Member

closes #27

@rokroskar rokroskar requested a review from ciyer May 27, 2019 19:38
Copy link
Contributor

@ciyer ciyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's missing is metadata describing the template (e.g., a name we can show in the UI). The original idea is that this would go in the template folders (python-minimal, R-minimal), but I think it would be better to have this in a separate file, for example manifest.yaml. This will be more efficient, since we initially only need to make one request to retrieve one file from the template repository.

I suggest something like this for the structure:

- 
  folder: python-minimal
  name: Basic Python Project
- 
  folder: R-minimal
  name: Basic R Project

This can later be expanded if necessary.

@rokroskar
Copy link
Member Author

How about:

templates:
  python-minimal:
    folder: python-minimal
    name: Basic Python Project
    description: The simplest renku project with a basic directory structure and necessary supporting files.

@ciyer
Copy link
Contributor

ciyer commented May 28, 2019

I considered something like this, but it makes it more difficult for the creator of templates to control the order in which they appear. For me, that was an argument against this, but maybe it doesn't matter.

@rokroskar
Copy link
Member Author

Agreed, should be a list

@rokroskar
Copy link
Member Author

rokroskar commented May 31, 2019

The other thing to consider here is whether we want to make these cookie-cutter compatible? That would make it cleaner for creating projects in the CLI, but I don't know if cookie-cutter would support this sort of structure (where different templates are parts of subdirectories).

@rokroskar rokroskar merged commit a56ec25 into master Jun 6, 2019
@rokroskar rokroskar deleted the new-templates branch June 6, 2019 11:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Define two basic project templates
3 participants