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

Create Blog “2022-09-07-my-experience-teaching-performance-engineering” #165

Open
wants to merge 110 commits into
base: main
Choose a base branch
from

Conversation

behoppe
Copy link
Member

@behoppe behoppe commented Sep 7, 2022

Automatically generated by Netlify CMS

@netlify
Copy link

netlify bot commented Sep 7, 2022

Deploy Preview for sage-licorice-6da44d ready!

Name Link
🔨 Latest commit 63b9644
🔍 Latest deploy log https://app.netlify.com/sites/sage-licorice-6da44d/deploys/64acd896de75fd0008c4409b
😎 Deploy Preview https://deploy-preview-165--sage-licorice-6da44d.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@behoppe behoppe assigned behoppe and jowens and unassigned behoppe Sep 7, 2022
@jowens
Copy link
Collaborator

jowens commented Sep 7, 2022

I believe @cleiserson wanted to actually discuss the content here before we published. I think he was enthusiastic about the overall content but had a few knobs he wanted me to tweak.

@behoppe
Copy link
Member Author

behoppe commented Sep 7, 2022

Hi @jowens. I have copied your draft article into a pull request on opencilk.org. This provides a place where you/we can make any edits before we publish. If you view this PR on github, you will also see a "Deploy Preview" link where there is an instance of the complete website that includes this post, as if it were published. (See pic below.)

I am going to encourage a couple other team members (@DorothyCurtis @neboat @ailiop) to read your draft so that we can provide feedback and advance this to publication.

My high-level feedback:

  • This is a great account of your experience. Thank you!
  • It might help to add something at the top that summarizes your take-aways, and maybe entices people to keep reading. For example, near the bottom is a header "The Future" with content that might do well near the top.
  • Would you like to encourage people to follow this example? Are you open to helping them? I hope the answers are "yes" and "yes," in which case I recommend making that prominent.
  • I recommend adding links (e.g., to 6.172 and other resources that you mention).
  • Can you provide a headshot that we can include with this? (Perhaps we simply use your GitHub profile pic?)
  • Another image or two might be good. Perhaps something for Potpourri and/or UC Davis?

Screenshot 2022-09-07 at 16-19-33 Create Blog “2022-09-07-my-experience-teaching-performance-engineering” by behoppe · Pull Request #165 · OpenCilk_www opencilk org

@behoppe
Copy link
Member Author

behoppe commented Sep 7, 2022

@jowens you are right that @cleiserson suggested some editorial review. If it works for you, let's please use this PR for making any edits, by pushing to cms/blog/2022-09-07-my-experience-teaching-performance-engineering on this repo. You can do this with your favorite GitHub tools, or you can use Netlify CMS as documented in our guidelines. Please let me know if you prefer a different way to edit. Thank you.

Bruce Hoppe and others added 21 commits September 12, 2022 13:08
Mainly to focus more on the "how-to" aspect and refer to the Reference manual
when needed.
- Remove TODO notes
- Use publicly accessible URLs for Cilkscale papers
- Small edits for clarity
- Minor edits in initial sections for clarity
- Remove some distracting comments
- Rephrase discussion on Cilkscale Python script to avoid ambiguity on what
  "benchmarking" means
- Regenerate final Cilkscale table and plots, and update "insights" accordingly
- Off-white axes foreground in plots
- Dotted grid lines in plots
- Correction in CLI-formatted CSV table output
- Consistent plot sizes
behoppe and others added 19 commits November 13, 2022 15:38
trim teach performance page and add modern algorithms workshop; add test join-us page with new form
survey iframe in join-us page
link to join-us from the community and teach-performance pages
Add new page for OpenCilk-related software, to hold some content originally included in /doc/users-guide/install.md.
Fix typo, and add reference to the page on contributing to OpenCilk.
Adjust level of headings.
Adjust level of final heading.
and add 11tydata.js files for community and contribute folders
Starting a list of open projects for prospective OpenCilk contributors.
Re-org of contribute.md which features teaching at the top and points to a new standalone page for open projects.
Revised description of DPRNG and pedigree support.
I took key take-aways  from "The Future" (concluding section) and put them at the top in a new introductory paragraph. I also added a headshot (based on JDO's GitHub profile).
…engineering' of github.com:opencilk/www.opencilk.org into cms/blog/2022-09-07-my-experience-teaching-performance-engineering
@behoppe
Copy link
Member Author

behoppe commented Mar 16, 2023

Hi @jowens. I discussed this post with @cleiserson and he suggested I implement the edits we sketched before (back in Sept). Along the way I rebased this branch on main. The biggest changes I made are at the very top -- with a headshot and a new opening paragraph. Can you please take a look? After the top, the rest of my edits are minor.

The other edits I hope to make on this post involve another page: Based on other discussions we've had about sharing EEC 289Q material, I plan to give that course a place in the Teach Performance Engineering page, so that MIT 6.106 has a heading, and so does UC Davis EEC 289Q. Thanks, John, for allowing us to share PDFs of your lectures publicly. I expect that page would hold the list of lectures, so that I could remove some/most of that detail from the blog post.

@behoppe
Copy link
Member Author

behoppe commented Mar 16, 2023

PS: the blog post preview is here https://deploy-preview-165--sage-licorice-6da44d.netlify.app/posts/2022-09-07-my-experience-teaching-performance-engineering/ (you can also find it from the deploy-preview that is included at the top of this PR).

@jowens
Copy link
Collaborator

jowens commented Mar 17, 2023

Splendid! May I edit that first paragraph so it sounds just a little more like me? I like the changes you made! I am, however, not sure on what I need to do to edit text at this point (what to do in git), need a hand there.

@behoppe
Copy link
Member Author

behoppe commented Mar 17, 2023

Yes -- please make it sound like you :-)

The post resides in branch cms/blog/2022-09-07-my-experience-teaching-performance-engineering. You should be able to check out that branch and update /src/posts/2022-09-07-my-experience-teaching-performance-engineering.md. If anything seems amiss (perhaps because I rebased with main yesterday) please let me know.

When you commit your changes to that same branch, it triggers a new deploy-preview automatically.

@jowens
Copy link
Collaborator

jowens commented Mar 17, 2023

ok, i think i figured out how to do this! stay tuned.

@behoppe
Copy link
Member Author

behoppe commented Mar 20, 2023

Thanks @jowens. Looks great! Charles asked that we change the title with "software performance engineering," which I did. I also made one tiny edit, so the sentence now reads:

So much of our teaching is small and deep slices of technical material, but it's at least as important to understand the big picture of techniques and approaches that cross layers of the computing stack.

Charles agrees with us that this is one post -- not something to break up. So we are holding this as "ready to publish" while we get our pipeline primed with more content and a better sense of our publication schedule. Thanks again for this great story.

@jowens
Copy link
Collaborator

jowens commented Mar 20, 2023

I am in support of all that!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants