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

contribution and maintenance simplification #62

Open
vlimant opened this issue Mar 26, 2021 · 3 comments
Open

contribution and maintenance simplification #62

vlimant opened this issue Mar 26, 2021 · 3 comments
Labels
question Further information is requested

Comments

@vlimant
Copy link
Contributor

vlimant commented Mar 26, 2021

inspirhep has apis to query up to date citation (updated doc when it becomes available for example). I see no reason not to use this valuable resource for optimizing the living review.
The essential information for the living review is the (inspire hep record #, section) tuple.
I'm sure people can come up with the proper python to turn a yaml (or any other simple format of desire) of the format

section1:
   subsection1.1:
      record: inspireheprecord1

into markdown and a properly formatted .tex and .bib files, with accurate ordering of references.
It will make contributing and maintaining this page much simpler.

@bnachman
Copy link
Collaborator

Hi @vlimant thank you for bringing this up! You have inspired me to add this functionality. Now, the make_md.py script automatically checks inspire and updates the journal refs. Please let me know if you had something else in mind.

@matthewfeickert
Copy link
Member

matthewfeickert commented Mar 27, 2021

I think that @vlimant had in mind the idea of thing being controlled through individual .yaml files (@vlimant correct?) similar to how the IRIS-HEP website works (c.f. iris-hep/iris-hep.github.io#603). However, it is worth noting that the IRIS-HEP website is exploiting a full Ruby framework to build the website out, and requires a larger understanding of how things work to contribute.

inspirhep has apis to query up to date citation (updated doc when it becomes available for example). I see no reason not to use this valuable resource for optimizing the living review.

@vlimant can you point to working examples of this that don't require a full framework? Or are you suggesting a total redesign of how things work?

@matthewfeickert matthewfeickert added the question Further information is requested label Mar 27, 2021
@vlimant
Copy link
Contributor Author

vlimant commented Mar 29, 2021

the heart of the review (HEPML.bib, HEPML.tex, README.md) can be generated from a yaml of the format provided earlier. one can use a framework, if one wants, but the suggestion for contribution is:

  1. edit the yaml file with the inspirehep record number under as many section as necessary
  2. run a script that generates HEPML.bib, HEPML.tex, README.md
  3. make a PR

that makes maintenance (i.e update citations with doi, etc) easier too (just running the script)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants