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

Make cmd tutorial for pkg template setup easier to find #21

Open
jamesmbaazam opened this issue Jan 20, 2023 · 4 comments
Open

Make cmd tutorial for pkg template setup easier to find #21

jamesmbaazam opened this issue Jan 20, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@jamesmbaazam
Copy link
Member

The tutorial that @pratikunterwegs kindly wrote to set up the package template using the terminal is very useful but almost invisible and hard to find. Maybe, it might help to add a link in the README for visibility.

@Bisaloo Bisaloo added the documentation Improvements or additions to documentation label Jun 22, 2023
@Bisaloo
Copy link
Member

Bisaloo commented Dec 7, 2023

My main blocker here is that I felt a tension between having the README as a template for the packages vs having a README talking about packagetemplate itself.

I've considered this a bit more and my conclusion is there is no probably problem to talk about packagetemplate in README.md while keeping README.Rmd as it is now. The README.md will be automatically overwritten as soon as the child repo gets its push first.

The only small downside is that README.md in packagetemplate can no longer serve as a preview of what README.Rmd contains. But that's maybe not a huge issue.

What do you think?

@pratikunterwegs
Copy link
Contributor

pratikunterwegs commented Dec 8, 2023

I think the (necessary) complexity of packagetemplate now means that it's better to use the 'Use as template' fuctionality than try to implement it all oneself, whether from the command line or otherwise. So I would actually be in favour of documenting the ingredients that have gone into it somewhere, perhaps in a technical appendix to Blueprints, and then actually removing this cli tutorial. As @jamesmbaazam says it's difficult to find anyway. The gh cli command to use it as a template perhaps saves a minute or two, so might be worth retaining somewhere.

Edit: I see that the cli steps apart from gh have already been removed. James' issue was opened nearly a year ago when all the steps were included, so I would say it's been superseded and the information currently there is fine.

@Bisaloo
Copy link
Member

Bisaloo commented Dec 8, 2023

Yes, I see the question more as: is the documentation in the wiki discoverable enough or should it be made more visible on the README? Beyond the specifics of what the documentation contains.

@pratikunterwegs
Copy link
Contributor

I suppose having this information in the Readme could help external devs who like the setup of Epiverse packages and want to copy it but are not that familiar with using GH templates. Not sure how applicable that is at the moment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants