Giter VIP home page Giter VIP logo

Comments (16)

brntbeer avatar brntbeer commented on May 18, 2024

Good find! Because the PDF files a bit harder to update, we were thinking of leaning more towards web-only view for these cheat sheets.

Is the translation in the .md file correct though?

from training-kit.

felipedau avatar felipedau commented on May 18, 2024

from training-kit.

brntbeer avatar brntbeer commented on May 18, 2024

By the way, if people ask for the PDF files, could they be hosted
somewhere and then use Webhooks to keep them synced?

Ideally i'd love it if the printed version of these web pages looked good enough to be thought of as PDF files. Otherwise we'd love to keep the PDFs here. I just currently know we don't have time to put together too many PDFs, very open to others adding it though

go ahead modify it, make a PR and then someone revises that?

Should it stress that it's Brazilian Portuguese?

I fully encourage you to submit PRs to revise it. Maybe even making a mention at the top of the file somewhere that it's Brazilian Portuguese (as i don't know the difference between types of Portuguese) to just give a notice to the reader.

Also, I found another bug in the PDF files. The EN version has the following
command:
However, none of the .md files have that command :O

It does appear that the description to using git config --global color.ui auto is wrong in the pt version of the pdf. In fact all of the .pdf files list this command, but they're not in the .md version. My vote is to remove them from the pdf's completely, as it's a default in modern versions of Git. Great catch!

from training-kit.

felipedau avatar felipedau commented on May 18, 2024

from training-kit.

felipedau avatar felipedau commented on May 18, 2024

from training-kit.

brntbeer avatar brntbeer commented on May 18, 2024

@felipedau i agree this issue should stay open until the problems in the original post are answered.

Taking a look at your PR now, thanks!

from training-kit.

brntbeer avatar brntbeer commented on May 18, 2024

Sorry for closing and re-opening.

I think I will leave this issue open until the PDF thing is solved.

@felipedau any update on this? I think keeping this open for the one specific piece to fix would be good.

from training-kit.

felipedau avatar felipedau commented on May 18, 2024

@felipedau any update on this? I think keeping this open for the one specific piece to fix would be good.

@brntbeer since I last posted to this issue, the pdf file was still outdated and that's why I left it open. However, as you mentioned in #334, the link points to an updated html page and I should've probably closed this one because there is no pdf file anymore.

Maybe a new one should be opened to find a general way to make these things build automatically to keep them synced, because it looks like it is done manually, right? I just edited a couple md and html files and I do not know how exactly the training-kit works, so correct me if I am wrong. If you think it is worth making some kind of automatic build system, we should probably open this new issue and discuss to find a solution. I honestly don't know where to start.

from training-kit.

brntbeer avatar brntbeer commented on May 18, 2024

If you think it is worth making some kind of automatic build system, we should probably open this new issue and discuss to find a solution. I honestly don't know where to start.

I agree that we should close this down and open an issue to at least speculate ways to get .pdfs to automatically get updated, or some alternative. Honestly if there was a "Print" button on the .html pages that printed the PDF, i think that would do.

@felipedau would you like to get started on that issue and close this one?

from training-kit.

felipedau avatar felipedau commented on May 18, 2024

I agree that we should close this down and open an issue to at least speculate ways to get .pdfs to automatically get updated, or some alternative. Honestly if there was a "Print" button on the .html pages that printed the PDF, i think that would do.

That's a great idea! I think that most of it can be done just by changing the CSS. It shouldn't be too hard.

@felipedau would you like to get started on that issue and close this one?

Sure. Are there any other resources that would be useful to be available as pdf files as well, or just the cheat sheets?

from training-kit.

felipedau avatar felipedau commented on May 18, 2024

Can I also make an issue to turn all the cheat sheets into html pages?

The whole website (including those pages) are synced with this repo, right? Or it still has to be built just like the pdf files?

from training-kit.

brntbeer avatar brntbeer commented on May 18, 2024

Sure. Are there any other resources that would be useful to be available as pdf files as well, or just the cheat sheets?

@felipedau i think just the cheat sheets or now. We can end up making the subversion migration one into pdf later and kind of continue to iterate on it.

Can I also make an issue to turn all the cheat sheets into html pages?

If you mean turn all of the pdfs into html, sure. The interesting part is that we already do have markdown converting it into html, so I wonder if some of that work is already done for us. Would be nice if the markdown pages we already have could stay for ease of editing. Maybe make it so if someone wanted to just see a pdf, they could switch to a different view or the html had a link to pdf every time (i wouldnt be against that i don't think =)

from training-kit.

brntbeer avatar brntbeer commented on May 18, 2024

The whole website (including those pages) are synced with this repo, right? Or it still has to be built just like the pdf files?

@felipedau sorry, i missed this. yes, everything that's at training.github.com/kit is on this repo itself. When we make the changes here (and probably test them locally) the @github/training-teachers would have to merge it into a private repo to get it deployed.

from training-kit.

felipedau avatar felipedau commented on May 18, 2024

@felipedau i think just the cheat sheets or now. We can end up making the subversion migration one into pdf later and kind of continue to iterate on it.

Sounds good.

If you mean turn all of the pdfs into html, sure. The interesting part is that we already do have markdown converting it into html, so I wonder if some of that work is already done for us. Would be nice if the markdown pages we already have could stay for ease of editing.

I noticed that the Brazilian Portuguese, Chinese and Italian cheat sheet links point to the html pages with that new layout, but the others don't. They are pdfs with the old layout. I would like that all those links pointed to an html page with the new layout. That will also make it easier to keep them synced with the repo and the md files should stay there, it's a lot easier to manage the content.

Maybe make it so if someone wanted to just see a pdf, they could switch to a different view or the html had a link to pdf every time (i wouldnt be against that i don't think =)

In my opion the pdf should be used as an offline copy of the html page, so making a link that generates a nice printable version of it that can be saved as a pdf is probably enough for the users. What do you think?

@felipedau sorry, i missed this. yes, everything that's at training.github.com/kit is on this repo itself. When we make the changes here (and probably test them locally) the @github/training-teachers would have to merge it into a private repo to get it deployed.

Cool! Then it seems that the easiest way to do what we want is doing md -> html -> pdf.

Finally, I would like to open the following issues:

  • Provide all the cheat sheets as html pages
  • Make the cheat sheets printable as pdf files with the same html layout

from training-kit.

crichID avatar crichID commented on May 18, 2024

Then it seems that the easiest way to do what we want is doing md -> html -> pdf.

@felipedau thank you for your thoughtful comments. I completely agree with you and would ❤️ to see this level of consistency among these resources. Please feel free to open a PR containing these changes!

from training-kit.

felipedau avatar felipedau commented on May 18, 2024

@felipedau thank you for your thoughtful comments. I completely agree with you and would ❤️ to see this level of consistency among these resources. Please feel free to open a PR containing these changes!

Sorry @crichID I think I was waiting for @brntbeer's confirmation and forgot this issue. Unfortunately I need help to make those changes, so I opened new issues ( #379, #380). This one can finally be closed!

from training-kit.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.