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

Remove pdfs from the repo #317

Open
cxkoda opened this issue Feb 22, 2020 · 4 comments
Open

Remove pdfs from the repo #317

cxkoda opened this issue Feb 22, 2020 · 4 comments

Comments

@cxkoda
Copy link

cxkoda commented Feb 22, 2020

To keep the repository tidy I suggest removing the pdfs entirely from the repository.
Since they are obtained directly from building they add no additional information and should hence not be part of the repository. Instead they pdfs should be obtained from the ci-pipeline.

What do you think?

@cxkoda cxkoda mentioned this issue Feb 22, 2020
@urbanhusky
Copy link

I think that the pdfs are a huge benefit because they give a proper preview.
The examples might also not build right out of the box (on Windows).

@cxkoda
Copy link
Author

cxkoda commented Feb 23, 2020

I agree the pdfs are very nice for the preview. But they bloat the whole repository, especially since the have to be rebuilt and updated after every change.

This can be avoided if we build the pdfs through the ci-pipeline and set links in the readme accordingly. Check out my pull request, or the master branch of my fork if you are interested how this would look like.

edit: typo

@rglastra
Copy link

rglastra commented Mar 1, 2020

That makes a ton of sense to me. If said examples are still readily viewable (since that's what draws new people in / gets them interested).

@cxkoda
Copy link
Author

cxkoda commented Mar 1, 2020

For demonstration I set the links in the readme of my fork to point to the respective circle-artifacts (e.g. https://circleci.com/api/v1.1/project/github/cxkoda/Awesome-CV/latest/artifacts/0/~/results/examples/resume.pdf?branch=master&filter=successful), which are rebuild by the ci-pipeline after every push.

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

No branches or pull requests

3 participants