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

Missing documentation for compiling songbook #59

Open
krestenlaust opened this issue Oct 14, 2023 · 2 comments
Open

Missing documentation for compiling songbook #59

krestenlaust opened this issue Oct 14, 2023 · 2 comments
Labels
a-meta Area: meta information, organisational changes, repository changes, etc. c-workflow Category: workflow changes d-medium Difficulty: medium p-high Priority: high

Comments

@krestenlaust
Copy link
Member

There isn't any documentation for any of the following:

  • The need to use the python tool in utils
  • That the F-klubben repository songbook is required
  • That pandoc is required for using the tool
  • Using the tool in general
@krestenlaust krestenlaust added a-meta Area: meta information, organisational changes, repository changes, etc. p-high Priority: high d-medium Difficulty: medium c-workflow Category: workflow changes labels Oct 14, 2023
@jonasKjellerup
Copy link
Collaborator

jonasKjellerup commented Oct 15, 2023

In case someone wants to give updating the documentation a shot. The meta-docs branch has some work in progress documentation that describes the project setup instructions. In relevance to this issue, it does describe how to build the songbook and the fact that is dependent on python and pandoc.

Some things not in the meta-docs branch:

  • Information about the docker setup in the utils directory.
  • Usage of the setup script. The meta-docs documentation draft was written before this was introduced.
  • Deployment instructions. (We should probably also write a new deployment script that actually works properly...)
  • Probably plenty of other stuff that I'm forgetting.

@jonasKjellerup
Copy link
Collaborator

As of #61 Pandoc is no longer a dependency for the songbook build script.

@krestenlaust krestenlaust changed the title Missing documentation for compiling songbook and pandoc prerequisite Missing documentation for compiling songbook May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a-meta Area: meta information, organisational changes, repository changes, etc. c-workflow Category: workflow changes d-medium Difficulty: medium p-high Priority: high
Projects
None yet
Development

No branches or pull requests

2 participants