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

common project.ptx + codespace config for contributions from CLI/codespace users #1959

Closed
wants to merge 8 commits into from

Conversation

StevenClontz
Copy link
Member

@oscarlevin please review. The idea that is whenever someone wants to make (say) a Guide contribution, they can do so using codespaces and our usual authoring tools, lowering barrier to helping improve documentation.

@oscarlevin
Copy link
Member

I think this is probably good. I like the idea of having a single project.ptx for all the different builds. Probably. Of course, I don't do that for all of my projects (a single manifest for all books on my computer), but I guess one per repository makes sense.

Just checking: the .gitignore is set up to ignore **/output, so all the different output folders get ignored, correct?

@StevenClontz
Copy link
Member Author

the .gitignore is set up to ignore **/output, so all the different output folders get ignored, correct?

yes

@StevenClontz
Copy link
Member Author

I don't do that for all of my projects (a single manifest for all books on my computer), but I guess one per repository makes sense.

Yeah, exactly. And the fact that there's no other way (currently, at least) to use pretext-tools other than with such a model. And I'm not sure there should be.

@StevenClontz
Copy link
Member Author

Yes, I set this up with texlive-full. https://tex.stackexchange.com/a/312867/

So I don't think 3 GB is unreasonable to avoid all the tricky LaTeX gotchas (basic GitHub users get 15 GB-mo for free). But what we need to do for pretextbook/pretext-codespace is set up https://docs.github.com/en/codespaces/prebuilding-your-codespaces so users get a quick full LaTeX+SageMath+etc machine on demand.

@StevenClontz StevenClontz requested review from rbeezer and oscarlevin and removed request for rbeezer March 25, 2023 01:35
@StevenClontz StevenClontz marked this pull request as ready for review March 25, 2023 01:35
@kcrisman
Copy link
Contributor

... so users get a quick full LaTeX+SageMath+etc machine on demand.

But ... isn't that what CoCalc also provides? And at least when I tried setting it up a codespaces in preparation for a workshop, it didn't really seem particularly faster to load than that solution. I guess at the least, it would be good to check how a normal-load browser (e.g. with multiple open tabs, email, etc.) actually loads that the first couple times.

@StevenClontz
Copy link
Member Author

StevenClontz commented Mar 25, 2023 via email

@kcrisman
Copy link
Contributor

kcrisman commented Mar 25, 2023 via email

@rbeezer
Copy link
Collaborator

rbeezer commented May 6, 2023

Not sure I got an answer? Is this ready to go?

@StevenClontz
Copy link
Member Author

You didn't - the Codespace took a while to set up and I'm just now running builds on all the projects.

@StevenClontz
Copy link
Member Author

I mean it didn't take two days; I just let it provision in the background and didn't get around to using it until just now. (-:

I just successfully built PDFs for the guide, showcase article, sample article, minimal, and humanities examples (the ones we've wired up so far). So I think this is good to go.

@rbeezer
Copy link
Collaborator

rbeezer commented May 7, 2023

Thanks! Didn't mean to rush you - hadn't realized there was a lag to get things setup.

Likely merge tomorrow.

@bnmnetp
Copy link
Contributor

bnmnetp commented May 7, 2023

There are pre-built textlive docker images... If we use one of those it would really reduce the amount of time it takes to set up a codespace. The installation of texlive with apt is one of the longest parts when I build new docker containers for Runestone and has had me looking for alternative ways of getting that set up.

@rbeezer
Copy link
Collaborator

rbeezer commented May 7, 2023

I'd like to keep the top-level directory of the repository relatively un-cluttered. And it would be nice if doc (or even doc/guide) were each relatively self-contained.

Q: could we have two such setups? One in doc and one in examples?

@StevenClontz
Copy link
Member Author

The codespaces setup only works if project.ptx is in the root of the repository. That's how the CLI knows that a repository is a PreTeXt project.

@StevenClontz
Copy link
Member Author

Closing in leiu of #2110

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 this pull request may close these issues.

None yet

5 participants