phd_thesis_markdown icon indicating copy to clipboard operation
phd_thesis_markdown copied to clipboard

Pre-PR Feature Approval

Open dendrondal opened this issue 4 years ago • 5 comments

Hello, I wanted to thank you for this repository. It made a huge difference in my writing process. I made several quality-of-life changes along the way that should be ready to merge into master, I just thought I'd get your opinion here first before bombarding you with PRs. Here are the proposed changes:

  1. Incorporation of pandoc-xnos to cut out latex figure referencing. Example thesis documentation and the Makefile have been changed accordingly.
  2. A new Makefile command to convert a traditional markdown table into pandoc's multiline tables. This automatically adds line breaks for particularly lengthy cells.
  3. Re-inclusion of pandoc-shortcaption (have tried this on Ubuntu and Mac, have not had any issues. The problem must have been fixed since it was removed)
  4. Editing of the readme to point to a blog post that addresses several pain points, including how to prevent Error 34.
  5. An install.sh script which automates install of the latex packages and pandoc plugins.

All this is contained in my fork if you want to look at it more closely. Please let me know which of these that you would like me to submit as PRs.

dendrondal avatar Dec 20 '19 18:12 dendrondal

Thanks @dendrondal. I have really fallen behind on this repo, so I'll try to make some time over the holiday to catch up. If you (or anyone else seeing this!) have an interest in helping to maintain the project, give me a shout.

tompollard avatar Dec 20 '19 18:12 tompollard

After many busy months, I finally ended up getting back to this. PR #93 covers all that's mentioned above, as well as adding Dockerization.

I'd be interested in joining as a maintainer, just bear in mind that my LaTeX knowledge is VERY limited, so I'm certainly unqualified to review any PRs or answer any issues relating to it. Anything else though, feel free to tag me!

dendrondal avatar Jun 12 '20 04:06 dendrondal

Thanks @dendrondal

I'd be interested in joining as a maintainer, just bear in mind that my LaTeX knowledge is VERY limited

Mine too, so we can muddle through this together. I've sent you an invite!

tompollard avatar Jun 12 '20 16:06 tompollard

So my Dockerization is ready to go, I want to pull in the changes from #95, but figured I'd go ahead and submit a PR for review. I did have a question, however: how to we want to go about adding the Docker implementation to Travis? These are the options:

  1. Add Docker to the current Travis pipeline. Max confidence, but will approximately double the build time, however.
  2. Leave the pipeline as-is, as the Dockerfile is nearly identical to install.sh
  3. Run Travis on ONLY the docker build (again, since it's identical), but run it against OSX, Linux, and Windows for maximum coverage. I'm not sure if Travis caches the container after building it, so not sure if it would keep build time the same or triple it.
  4. Combine 3&4

If you want me to submit the PR and then make the decision, that's fine too.

dendrondal avatar Aug 26 '20 17:08 dendrondal

Add Docker to the current Travis pipeline. Max confidence, but will approximately double the build time, however.

thanks @dendrondal. this sounds good to me, as long as you don't see any issues. extra build time isn't a problem as far as i'm concerned, unless it leads to build failures as a result of exceeding time limits (which I don't will be the case: https://docs.travis-ci.com/user/customizing-the-build/#build-timeouts).

tompollard avatar Aug 28 '20 15:08 tompollard