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

Create a init script? #401

Closed
swamidass opened this issue Dec 15, 2020 · 1 comment
Closed

Create a init script? #401

swamidass opened this issue Dec 15, 2020 · 1 comment

Comments

@swamidass
Copy link

The instructions for starting a new manuscript are pretty involved: https://github.com/manubot/rootstock/blob/master/SETUP.md

Could you add a set up script which would make this work differently? E.g. make it so that manubot can be "installed," such that it provides a command line tool, which can create a new manuscript. This would reduce the process to a single command, and also make it the process maintainable.

@swamidass swamidass changed the title Create a sub Create a init script? Dec 15, 2020
@agitter
Copy link
Member

agitter commented Dec 20, 2020

Initially we did not attempt to automate more of the setup steps because there were two steps that were typically performed outside the command line: creating the new repository on GitHub and setting up continuous integration. Now that the default continuous integration moved to GitHub Actions, creating the repository is probably the only step that would need to be automated in order to create a new manuscript with a single script.

An intermediate step would be to reorder the instructions. The user could first create the new repository at https://github.com/new. Then, they could run a script to convert that new, empty repository into a Manubot manuscript.

Automating everything would require authenticating at the command line. The GitHub API can be used to create a repository. It looks like it requires a token, which could be less user-friendly than our current setup process. The GitHub command line interface has a create command and supports more authentication options. However, that would add an additional dependency to the setup.

@nfry321 nfry321 mentioned this issue Mar 8, 2021
bluegenes added a commit to bluegenes/2021-paper-sourmash-distance that referenced this issue May 19, 2021
* Webpage: refactor plugins & add scite plugin

merges manubot/rootstock#409

* moves repeated and shared/generic functions to separate "core" plugin
* reorganizes html.yaml config into first and third party plugins
* removes functionality to set plugin options from url
* reformats plugins with Prettier (eg 4 space tabs to 2 space)
* removes anonymizer wrapper. Just make <script> tag into module to keep scope local
  and avoid function name conflicts. this reduces the indent of the whole script by one level.
* moves plugin specific CSS to plugins themselves
* adds scite plugin (uncomment to enable)

* Update scite plugin

merges manubot/rootstock#415

* setup.bash: interactive script to guide setup

merges manubot/rootstock#417
closes manubot/rootstock#401

* Add "gh repo create" to SETUP.md

merges manubot/rootstock#419
closes manubot/rootstock#418

Co-authored-by: Daniel Himmelstein <daniel.himmelstein@gmail.com>
Co-authored-by: Anthony Gitter <agitter@users.noreply.github.com>

* fix link

Co-authored-by: Vincent Rubinetti <vince.rubinetti@gmail.com>
Co-authored-by: nfry321 <58332182+nfry321@users.noreply.github.com>
Co-authored-by: Tiago Lubiana <tiago.lubiana.alves@usp.br>
Co-authored-by: Daniel Himmelstein <daniel.himmelstein@gmail.com>
Co-authored-by: Anthony Gitter <agitter@users.noreply.github.com>
trangdata added a commit to greenelab/iscb-diversity-manuscript that referenced this issue Aug 5, 2021
* setup.bash: interactive script to guide setup

merges manubot/rootstock#417
closes manubot/rootstock#401

* Add "gh repo create" to SETUP.md

merges manubot/rootstock#419
closes manubot/rootstock#418

Co-authored-by: Daniel Himmelstein <daniel.himmelstein@gmail.com>
Co-authored-by: Anthony Gitter <agitter@users.noreply.github.com>

* BUILD_LATEX for basic LaTeX manuscript

merges manubot/rootstock#384
refs manubot/rootstock#249

* Pandoc 2.14: update HTML plugins, CSL style, citekey syntax

merges manubot/rootstock#427

Co-authored-by: Daniel Himmelstein <daniel.himmelstein@gmail.com>
Co-authored-by: Anthony Gitter <agitter@users.noreply.github.com>

Co-authored-by: nfry321 <58332182+nfry321@users.noreply.github.com>
Co-authored-by: Tiago Lubiana <tiago.lubiana.alves@usp.br>
Co-authored-by: Daniel Himmelstein <daniel.himmelstein@gmail.com>
Co-authored-by: Anthony Gitter <agitter@users.noreply.github.com>
Co-authored-by: Vincent Rubinetti <vince.rubinetti@gmail.com>
ploegieku added a commit to ploegieku/2023-functional-homology-paper that referenced this issue Aug 6, 2024
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

No branches or pull requests

2 participants