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

Publish en/lessons/simulating-historical-communication-networks-python #3455

Merged

Conversation

anisa-hawes
Copy link
Contributor

@anisa-hawes anisa-hawes commented Jan 9, 2025

Preparing files for publication.

Closes #3454

Checklist

  • Assign yourself in the "Assignees" menu
  • Add the appropriate "Label"
  • If this PR closes an Issue, add the phrase Closes #ISSUENUMBER to your summary above
  • Ensure the status checks pass: if you have difficulty fixing build errors, please contact our Publishing Manager @anisa-hawes
  • Check the Netlify Preview: navigate to netlify/ph-preview/deploy-preview and click 'details' (at right)
  • Assign at least one individual or team to "Reviewers"
    • if the text needs to be translated, please follow the translation request guidelines, then assign the relevant language team(s) as "Reviewers" and tag both the team as well as the managing editor in your PR.

@anisa-hawes anisa-hawes self-assigned this Jan 9, 2025
@anisa-hawes
Copy link
Contributor Author

anisa-hawes commented Jan 10, 2025

Hello Alex @hawc2,

I’ve staged simulating-historical-communication-networks-python for publication. You can read it through in Preview and let me know if you note anything which you'd like to adjust.

If you're happy, we can publish this lesson next Wednesday.

Thank you!

@anisa-hawes anisa-hawes requested a review from hawc2 January 10, 2025 13:02
@hawc2
Copy link
Contributor

hawc2 commented Jan 10, 2025

@anisa-hawes do we usually highlight code packages? In this case, should mesa be listed as mesa?

One other thing I can't recall us doing is giving subsections numbering, so there's 1.1 before Why use Historical Simulations for our Case Study?

I'm fine with us leaving it, just wanted to flag as it stood out as not the standard formatting.

Otherwise, this lesson has been through the ringer, and is looking really solid. I don't see any other issues, images are rendering well and everything

@charlottejmc
Copy link
Contributor

charlottejmc commented Jan 15, 2025

Hi @hawc2, we haven't been highlighting package/library names because that can make the typesetting look very heavy. Technically, they're not really parts of 'code' per se. This is a bit of an open question, though, so do let us know if you feel they should be written between backticks.

Numbering sections isn't the usual formatting, but I felt that it made this lesson's many steps/subsections somewhat easier to navigate so I kept them in. What do you think?

@hawc2
Copy link
Contributor

hawc2 commented Jan 15, 2025

Thanks @charlottejmc, I see that makes sense. I don't have a strong opinion on either of these choices, it's fine to not use highlights for code packages, and to use numbering for TOC. I'd just say we should probably do it for all future lessons

hawc2
hawc2 previously approved these changes Jan 15, 2025
@anisa-hawes
Copy link
Contributor Author

Thank you, @hawc2!

We have encountered a couple of issues with some branch conflicts, but all resolved now!

@anisa-hawes anisa-hawes merged commit 76a7a6b into gh-pages Jan 22, 2025
5 checks passed
@anisa-hawes anisa-hawes deleted the publish-simulating-historical-communication-networks-python branch January 22, 2025 12:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Preparing to publish a new EN original lesson: simulating-historical-communication-networks-python
3 participants