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

[READY FOR REVIEW] PPIE version of Inclusive Events chapter #3550

Merged

Conversation

BrainonSilicon
Copy link
Collaborator

@BrainonSilicon BrainonSilicon commented Feb 23, 2024

Summary

This is the first draft of the PPIE version of the Inclusive Events chapter.

The chapter contains guidance and recommendations for how to design an event to be inclusive and engaging for patients and members of the public who are part of a research project's "PPIE" work packages.

PPIE stands for Public and Patient Involvement and Engagement. You can read more about PPIE here.

The chapter is a collection of best practices and recommendations developed by PPIE professionals and contributors to help future projects run inclusive and ethical PPIE events.

It is written in tandem with an Accessibility focused version of the chapter which focuses on accessibility requirements and disability inclusion. For more information about the two chapters, please refer to Issue #3307.

List of changes proposed in this PR (pull-request)

  • Added content to chapter about running and hosting PPIE events
  • Initializing update with main branch content
  • File name changes from inclusive-events to ppie-events
  • Changed content from the initial chapter draft to remove accessibility-specific information
  • Rephrased chapter to focus on PPIE-specific recommendations
  • Added references to book/website/_bibliography/references.bib that were cited in the chapter content
  • Added "Plain Language" and definition to the glossary (book/website/afterword/glossary.md)
  • Added files to the _toc (table of contents)

What should a reviewer concentrate their feedback on?

  • Reviewers should focus their review on the following files:
    • book/website/collaboration/ppie-events.md
    • book/website/collaboration/ppie-events/ppie-events-planning.md
    • book/website/collaboration/ppie-events/ppie-events-location.md
    • book/website/collaboration/ppie-events/ppie-events-schedules.md
    • book/website/collaboration/ppie-events/ppie-events-comms.md
    • book/website/collaboration/ppie-events/ppie-events-socials.md
    • book/website/collaboration/ppie-events/ppie-events-tech.md
    • book/website/_bibliography/references.bib
    • book/website/afterword/glossary.md
    • _toc.yml

When reviewing these files please review for

  • content
  • is anything missing?
  • spelling mistakes and grammar

Acknowledging contributors

  • All contributors to this pull request are already named in the table of contributors in the README file.

Other Information

When reviewing please keep in mind that accessibility requirements and discussion regarding disability is not featured in this version of the chapter.

Many sections from the original draft have been removed, and you can review a comparison of the headings and sections between drafts in the heading_comparison_inclusive_events_chapters.csv file.

  • The Accessibility focused version of the chapter will go into these topics in more detail.

BrainonSilicon and others added 30 commits November 2, 2023 16:52
Co-authored-by: Bastian Greshake Tzovaras <bgreshake@googlemail.com>
Added bold formatting to terms in the introduction
Added in example in response to BGT's review comment #3327 (comment)
Co-authored-by: Bastian Greshake Tzovaras <bgreshake@googlemail.com>
Co-authored-by: Bastian Greshake Tzovaras <bgreshake@googlemail.com>
Co-authored-by: Bastian Greshake Tzovaras <bgreshake@googlemail.com>
Co-authored-by: Bastian Greshake Tzovaras <bgreshake@googlemail.com>
Fixed line break formating to remove line breaks and have each new sentence start on a new line
and also addressed comment #3327 (comment) by splitting the presentations and event content section
Moving the information in the Content Accessibility Guidance section to a new subsection of the chapter.
- made dress code its own section
- made sickness policy its own section
- updated the checklist
- moved the checklist to the end of the page
- added a sentence into the introduction about the checklist
Co-authored-by: Bastian Greshake Tzovaras <bgreshake@googlemail.com>
Co-authored-by: Bastian Greshake Tzovaras <bgreshake@googlemail.com>
Co-authored-by: Bastian Greshake Tzovaras <bgreshake@googlemail.com>
Co-authored-by: Esther Plomp <46314469+EstherPlomp@users.noreply.github.com>
Removed british museum example
@BrainonSilicon
Copy link
Collaborator Author

Hiya @JimMadge (or @the-turing-way/infrastructure-working-group team)

I wanted to check if we intended to keep some work we did while playing around fixes the branches a few weeks ago.

Changes

In this PR the .github/workflows/ci.yml file is edited so that some of the checks run on PRs that aren't just ones that push to main.

  • Did we intend to keep this change (we don't need to!!) or should I revert it?

Considerations

  • Will the change run down the deployment minutes allocation that TTW has?
  • Does it improve the workflow of folks contributing to TTW?

@bsipocz
Copy link
Member

bsipocz commented Apr 22, 2024

In this PR the .github/workflows/ci.yml file is edited so that some of the checks run on PRs that aren't just ones that push to main.

Did we intend to keep this change (we don't need to!!) or should I revert it?

Yes, those changes should be reverted and this PR should contain no changes to the CI config.

I also wonder whether this PR is indeed ~300 commits strong or something else is going on with its commit history.

@BrainonSilicon
Copy link
Collaborator Author

BrainonSilicon commented Apr 22, 2024

In this PR the .github/workflows/ci.yml file is edited so that some of the checks run on PRs that aren't just ones that push to main.
Did we intend to keep this change (we don't need to!!) or should I revert it?

Yes, those changes should be reverted and this PR should contain no changes to the CI config.

I also wonder whether this PR is indeed ~300 commits strong or something else is going on with its commit history.

Hi @bsipocz

Thank you for confirming! I'll fix that now :)

On the other note, the chapter has been a massively massively iterative process and it is now almost 300 commits deep. A lot of them have been related to small wording changes and phrasing adjustments.
The draft word count was almost 30,000 before starting review and it's more a case of not always batching commits, using the browser instead of editor, and working with the reviews directly in the PR instead of using the branches.

@BrainonSilicon BrainonSilicon self-assigned this Apr 22, 2024
replaced the previously removed deployment rule in the ci to deploy only for PRs with branches that pushed to main
Copy link
Collaborator Author

@BrainonSilicon BrainonSilicon left a comment

Choose a reason for hiding this comment

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

The chapter is starting to come together!

Copy link
Collaborator Author

@BrainonSilicon BrainonSilicon left a comment

Choose a reason for hiding this comment

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

made phase 1 of additions to the location section based on community feedback

@BrainonSilicon
Copy link
Collaborator Author

In preparation for the chapter being merged during CW24. This PR is now being merged into the WIP-Inclusive-Events-chapter branch 🚀

Thank you everyone for your reviews and feedback so far.

It's awesome to see how the chapter has progressed.

@BrainonSilicon BrainonSilicon merged commit d63cc55 into WIP]Inclusive-Events-chapter Apr 26, 2024
2 checks passed
@BrainonSilicon BrainonSilicon deleted the WIP-Inclusive-Events-chapter-Content branch April 26, 2024 12:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

8 participants