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

Add overview sections for roles #73

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

Conversation

markweldensmith
Copy link
Contributor

Add two new files reflecting the community and eScience hackweek roles. Text pulled from the website.

Once approved, will add icons from #72 & #71.

Add two new files reflecting the community and eScience hackweek roles. Text pulled from the website.
@markweldensmith markweldensmith added the documentation Improvements or additions to documentation label Dec 9, 2024
aaarendt pushed a commit that referenced this pull request Dec 9, 2024
Merging to migrate this effort over to #73
Copy link

github-actions bot commented Dec 9, 2024

@JessicaS11
Copy link
Contributor

Way back when (pre #48) we had some ideas around how to best include the role content (and some images to try and help folks navigate the roles). How do we envision helping planning teams navigate assigning these roles within their team, and how do the roles fit in with different types of hackweek support we are offering (e.g. those we are actively planning/hosting versus those we are providing only a smaller, consultation participation in)? I'm just noticing that many of the "eScience team" roles are still critical shoes to fill if you're planning an event that we're NOT helping organize, and teams may want to consider having them.

docs/Roles/Community-Lead.md Outdated Show resolved Hide resolved
docs/Roles/Community-Lead.md Outdated Show resolved Hide resolved
docs/Roles/Project-Consultant.md Outdated Show resolved Hide resolved
docs/_toc.yml Outdated Show resolved Hide resolved
docs/_toc.yml Outdated Show resolved Hide resolved
docs/roles/Collaboration-Architect.md Outdated Show resolved Hide resolved
docs/overview/eScience-Staff-Roles.md Outdated Show resolved Hide resolved
@uwhackweek uwhackweek deleted a comment from markweldensmith Jan 22, 2025
@JessicaS11
Copy link
Contributor

@markweldensmith Is this ready for content review?

As a side note, we'll also need to do some formatting in the .md files to follow best practices for line length. @jomey or @scottyhq I know we've oscillated over time; do either of you recall if we settled on newlines for all new sentences or only after x characters (and what x we used!)? My personal preference is usually a combination (newline for all new sentences/logical breaks like compound sentences AND then any lines that are still above the character limit), because it makes future edits easier to review.

@markweldensmith
Copy link
Contributor Author

markweldensmith commented Jan 27, 2025 via email

@jomey
Copy link
Contributor

jomey commented Jan 28, 2025

As a side note, we'll also need to do some formatting in the .md files to follow best practices for line length. @jomey or @scottyhq I know we've oscillated over time; do either of you recall if we settled on newlines for all new sentences or only after x characters (and what x we used!)? My personal preference is usually a combination (newline for all new sentences/logical breaks like compound sentences AND then any lines that are still above the character limit), because it makes future edits easier to review.

I don't remember what/if we had something for this.

Personally, I have a visual guide around 80 characters in all my editors (code of md) that I use the upper limit for characters in one line. Makes it easier for me to use documents in split window view and also edit sentences that are long. I don't do anything around sentences and break up paragraphs with a new line.

Suggest to set a character limit via the .editorconifg in the repos that should be picked up by most common IDEs/editors.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation preview
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants