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.

Sign up for GitHub

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

Jump to bottom

Added cheatsheet PDF download to cheatsheet page #13909

Merged
merged 7 commits into from May 16, 2024
Merged

Added cheatsheet PDF download to cheatsheet page #13909

merged 7 commits into from May 16, 2024

Conversation

kathatherine
Copy link
Contributor

@kathatherine kathatherine commented May 10, 2024 •
edited

Description

Closes #13908.

Added cheatsheet PDF download to the new cheatsheet text page. I didn't add an extra folder or symlink back in just yet. I'm not sure if we are going to want to have a new PDF for each version or not.

I also added back in the tips from the PDF, since it'll be more directly comparable. These may or may not be helpful, but can probably be fit into the auto PDF once we figure all of that out.

Checklist - did you ...

  • Add a file to the news directory (using the template) for the next release's release notes?
  • [ ] Add / update necessary tests?
  • [ ] Add / update outdated documentation?

@kathatherine kathatherine requested a review from a team as a code owner May 10, 2024 17:20
@conda-bot conda-bot added the cla-signed [bot] added once the contributor has signed the CLA label May 10, 2024
jezdez
jezdez previously approved these changes May 10, 2024
View reviewed changes
Copy link
Member

@jezdez jezdez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Naming aside, this looks great! Thank you, @kathatherine!

docs/source/user-guide/conda-cheatsheet.pdf Outdated Show resolved Hide resolved
docs/source/user-guide/cheatsheets/conda-cheatsheet-24.4.0.pdf Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for being a stickler, could we name the file conda-24.4.0.pdf like the other files in the folder?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a problem! I missed that the first time because I wasn't reading carefully enough. I appreciate you being a stickler.

beeankha
beeankha previously approved these changes May 12, 2024
View reviewed changes
Copy link
Contributor

@beeankha beeankha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than Jannis's comment here (which I agree with), this looks good to go!

@kathatherine
Copy link
Contributor Author

Also, one more thing, @jezdez, I deleted the old cheatsheet PDFs in the cheatsheet PR before this one. Your comment above makes me think we actually want to keep those. I can add them back in, if so.

@kathatherine kathatherine dismissed stale reviews from beeankha and jezdez via cafdafb May 13, 2024 14:15
@beeankha
Copy link
Contributor

beeankha commented May 13, 2024 •
edited

Also, one more thing, @jezdez, I deleted the old cheatsheet PDFs in the cheatsheet PR before this one. Your comment above makes me think we actually want to keep those. I can add them back in, if so.

I know you were asking @jezdez but I want to add my opinion that I don't think that any of the old cheat sheets should be on that page, since a lot of them have outdated info and folks can go to an older version of the docs in order to access the previous cheat sheets (but I defer to what @jezdez thinks is best!).

PS - I might be misunderstanding; if you're talking about reverting the deletion of an old cheat sheet from an older version of the docs, then yes please add it back!

@jezdez
Copy link
Member

jezdez commented May 13, 2024

Also, one more thing, @jezdez, I deleted the old cheatsheet PDFs in the cheatsheet PR before this one. Your comment above makes me think we actually want to keep those. I can add them back in, if so.

Oh I missed that. My worry is that someone was linking to the old files and it's now 404'ing. Maybe we could resolve that with a redirect instead?

@jezdez
Copy link
Member

jezdez commented May 13, 2024

Also, one more thing, @jezdez, I deleted the old cheatsheet PDFs in the cheatsheet PR before this one. Your comment above makes me think we actually want to keep those. I can add them back in, if so.

I know you were asking @jezdez but I want to add my opinion that I don't think that any of the old cheat sheets should be on that page, since a lot of them have outdated info and folks can go to an older version of the docs in order to access the previous cheat sheets (but I defer to what @jezdez thinks is best!).

PS - I might be misunderstanding; if you're talking about reverting the deletion of an old cheat sheet from an older version of the docs, then yes please add it back!

Gotcha, I missed the deletion, my only worry is breaking links to the old PDFs via the stable or latest docs builds that would end being a 404 without resolution.

@kathatherine
Copy link
Contributor Author

Gotcha. Apologies for the misunderstanding! I downloaded them from stable and added them back in.

@jezdez jezdez merged commit 49f2614 into conda:main May 16, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jezdez jezdez jezdez approved these changes

@beeankha beeankha beeankha left review comments

Assignees
No one assigned
Labels
cla-signed [bot] added once the contributor has signed the CLA
Projects
🔎 Review
Status: 🏁 Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add updated cheatsheet PDF to cheatsheet page
4 participants
@kathatherine @beeankha @jezdez @conda-bot