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

Add link to meta-review in README of rootstock #216

Closed
slochower opened this issue Apr 27, 2019 · 4 comments · Fixed by #217
Closed

Add link to meta-review in README of rootstock #216

slochower opened this issue Apr 27, 2019 · 4 comments · Fixed by #217

Comments

@slochower
Copy link
Collaborator

I think we should add a citation to the meta-review here. If I redirect someone to www.manubot.org (which comes to this repository), there isn't a quick & easy thing describing the advantages and disadvantages, which we have laid out in meta-review. What do you think @agitter?

@agitter
Copy link
Member

agitter commented Apr 27, 2019

The list time we discussed this in manubot/manubot#59 we decided to put the meta review link in USAGE.md to help avoid confusion about what to cite in manuscript repositories. However, that may have been before www.manubot.org, and the meta review itself has changed substantially since then. It is now a much better explanation of why someone should use Manubot.

I'm open to making the meta review link more prominent in the main readme. Unless there are plans to build out www.manubot.org in the short term and make that the best resource for prospective users.

@slochower
Copy link
Collaborator Author

slochower commented Apr 27, 2019

Right. I think featuring it more prominently is important. Someone is only going to click on USAGE.md if they want to use the package... which they might not want to do unless they see some justification and cool features :)

In other words, if I say "hey, we've got this cool package that will help revolutionize scholarly writing, check it out at www.manubot.org" and then all that's there is a landing page that says "Clone me to create your manuscript" and "This repository is a template manuscript (a.k.a. rootstock)." I think we are doing a disservice to ourselves. Do you see what I mean?

@dhimmel
Copy link
Member

dhimmel commented Apr 30, 2019

I think #217 is a good start. Hopefully, we'll get a landing page up in the next couple months, that provides a better overview than the rootstock repo.

@slochower
Copy link
Collaborator Author

Agree, sounds good for now.

agitter added a commit that referenced this issue May 1, 2019
dhimmel pushed a commit that referenced this issue May 1, 2019
This build is based on
8d74236.

This commit was created by the following Travis CI build and job:
https://travis-ci.com/manubot/rootstock/builds/110208092
https://travis-ci.com/manubot/rootstock/jobs/196821532

[ci skip]

The full commit message that triggered this build is copied below:

Add meta review link to readme

Merges #217
Closes #216
dhimmel pushed a commit that referenced this issue May 1, 2019
This build is based on
8d74236.

This commit was created by the following Travis CI build and job:
https://travis-ci.com/manubot/rootstock/builds/110208092
https://travis-ci.com/manubot/rootstock/jobs/196821532

[ci skip]

The full commit message that triggered this build is copied below:

Add meta review link to readme

Merges #217
Closes #216
slochower added a commit to slochower/smirnoff-host-guest-manuscript that referenced this issue May 15, 2019
* webpage.py: note to ignore error in versions checkout

Merges manubot/rootstock#211
Closes manubot/rootstock#183

* Use Athena to build PDF, if Docker installed

Merges manubot/rootstock#210
Closes manubot/rootstock#170

More information about Athena is available at
https://github.com/arachnys/athenapdf

Based on meta-review commit:
greenelab/meta-review@cffcfea

* Add meta review link to readme

Merges manubot/rootstock#217
Closes manubot/rootstock#216

* Increase shared memory of athenapdf container

Merges manubot/rootstock#220
Closes arachnys/athenapdf#195

Increase --shm-size from the default value of 64m to 1g when
running the athenapdf Docker image. Resolves athena issue:
`The renderer process has crashed`

Switch to using equal sign to separate Docker arguments
and values for consistency.
https://stackoverflow.com/q/50319060/4651668

* CSL author macro: substitute editor/venue

Merges manubot/rootstock#219

Ensures there is a newline between the title and venue,
when authors are missing.
Closes manubot/rootstock#218
Supersedes manubot/rootstock#158

Substitutes editors for authors when authors are missing.
Editors are labeled like "Sönke Bartling, Sascha Friesike (editors)".
slochower added a commit to slochower/smirnoff-host-guest-manuscript that referenced this issue May 15, 2019
This build is based on
d62afc4.

This commit was created by the following Travis CI build and job:
https://travis-ci.com/slochower/smirnoff-host-guest-manuscript/builds/532938787
https://travis-ci.com/slochower/smirnoff-host-guest-manuscript/jobs/532938788

[ci skip]

The full commit message that triggered this build is copied below:

Rootstock 2019 05 15 (#36)

* webpage.py: note to ignore error in versions checkout

Merges manubot/rootstock#211
Closes manubot/rootstock#183

* Use Athena to build PDF, if Docker installed

Merges manubot/rootstock#210
Closes manubot/rootstock#170

More information about Athena is available at
https://github.com/arachnys/athenapdf

Based on meta-review commit:
greenelab/meta-review@cffcfea

* Add meta review link to readme

Merges manubot/rootstock#217
Closes manubot/rootstock#216

* Increase shared memory of athenapdf container

Merges manubot/rootstock#220
Closes arachnys/athenapdf#195

Increase --shm-size from the default value of 64m to 1g when
running the athenapdf Docker image. Resolves athena issue:
`The renderer process has crashed`

Switch to using equal sign to separate Docker arguments
and values for consistency.
https://stackoverflow.com/q/50319060/4651668

* CSL author macro: substitute editor/venue

Merges manubot/rootstock#219

Ensures there is a newline between the title and venue,
when authors are missing.
Closes manubot/rootstock#218
Supersedes manubot/rootstock#158

Substitutes editors for authors when authors are missing.
Editors are labeled like "Sönke Bartling, Sascha Friesike (editors)".
slochower added a commit to slochower/smirnoff-host-guest-manuscript that referenced this issue May 15, 2019
This build is based on
d62afc4.

This commit was created by the following Travis CI build and job:
https://travis-ci.com/slochower/smirnoff-host-guest-manuscript/builds/532938787
https://travis-ci.com/slochower/smirnoff-host-guest-manuscript/jobs/532938788

[ci skip]

The full commit message that triggered this build is copied below:

Rootstock 2019 05 15 (#36)

* webpage.py: note to ignore error in versions checkout

Merges manubot/rootstock#211
Closes manubot/rootstock#183

* Use Athena to build PDF, if Docker installed

Merges manubot/rootstock#210
Closes manubot/rootstock#170

More information about Athena is available at
https://github.com/arachnys/athenapdf

Based on meta-review commit:
greenelab/meta-review@cffcfea

* Add meta review link to readme

Merges manubot/rootstock#217
Closes manubot/rootstock#216

* Increase shared memory of athenapdf container

Merges manubot/rootstock#220
Closes arachnys/athenapdf#195

Increase --shm-size from the default value of 64m to 1g when
running the athenapdf Docker image. Resolves athena issue:
`The renderer process has crashed`

Switch to using equal sign to separate Docker arguments
and values for consistency.
https://stackoverflow.com/q/50319060/4651668

* CSL author macro: substitute editor/venue

Merges manubot/rootstock#219

Ensures there is a newline between the title and venue,
when authors are missing.
Closes manubot/rootstock#218
Supersedes manubot/rootstock#158

Substitutes editors for authors when authors are missing.
Editors are labeled like "Sönke Bartling, Sascha Friesike (editors)".
adebali pushed a commit to CompGenomeLab/lemur-manuscript-archive that referenced this issue Mar 4, 2020
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

Successfully merging a pull request may close this issue.

3 participants