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

Update about-the-website-development-team.md #11

Merged
merged 2 commits into from
Oct 29, 2023

Conversation

vraer
Copy link
Member

@vraer vraer commented Oct 17, 2023

Summary

This PR migrates the About the Website Development Team page from the GitHub wiki to the new mkdocs site.

Changes

  • Added mermaid diagram to visualize skill progression pathway
  • Included note box to highlight exceptions can be discussed
  • Formatted content for improved readability and consistency

Please review and let me know if any details need to be modified or expanded on.


Screenshots

Edit

about-the-website-dev-team_edit

Original

about-the-website-dev-team_original

@vraer
Copy link
Member Author

vraer commented Oct 20, 2023

@JessicaLucindaCheng @roslynwythe

I've come across a few open issues related to content duplication (see below). As this PR is being considered, should we also think about instances where we can instead link back to a main source? Like meetings/schedule info or things that don't require additional context or explanation.

Examples of related issues

repeat-info

To get this started, we could identify/review topics covered on high-traffic pages:

Thoughts?

@JessicaLucindaCheng

This comment was marked as outdated.

@JessicaLucindaCheng
Copy link
Member

JessicaLucindaCheng commented Oct 23, 2023

@vraer

I've come across a few open issues related to content duplication (see below). As this PR is being considered, should we also think about instances where we can instead link back to a main source? Like meetings/schedule info or things that don't require additional context or explanation.

I think you make a good point about duplicate content and that it is better to link to one source. I will keep that in mind for #2746 (the issue I am assigned to). Also, I'll see if there is anything on the "About the Website Development Team" that we can have links to instead of repeating on the page when I review your pr.

I can't comment on the particulars of the other issues you listed but in general, I think not repeating content is a good idea. Since @roslynwythe is the current Tech Lead, I'll let her answer your other questions and provide guidance on what she thinks should be worked on next.

Copy link
Member

@JessicaLucindaCheng JessicaLucindaCheng left a comment

Choose a reason for hiding this comment

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

@vraer Good job refining and rewording the original content! I think it is a lot better.

See my in-line change requests. Thanks!

docs/roles/dev/about-the-website-development-team.md Outdated Show resolved Hide resolved
Copy link
Member

@JessicaLucindaCheng JessicaLucindaCheng left a comment

Choose a reason for hiding this comment

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

@vraer One more in-line change request.

docs/roles/dev/about-the-website-development-team.md Outdated Show resolved Hide resolved
@JessicaLucindaCheng
Copy link
Member

@vraer Leaving this as only as suggestions for future versions of this page and not necessary to implement for this pr:

  • Team Levels section could probably go on the Joining the hackforla org website team wiki page.
    • The wording would need to be generalized, so Development Team and new developers could be changed to Website Team and new members, respectively
  • Time Commitment, Communication, Skill Progression, and probably the line "Work on one issue at a time" could probably go on the Joining the hackforla org website team wiki page because I think these requirements apply to all members and not just devs.
    • The info could probably go in section 2.1 Hack for LA in CONTRIBUTING.md as well instead of the wiki. However, I think it makes more sense to put the content in the wiki and link it in section 2.1.
  • If a line was added to the "Let's go!" section on Joining the hackforla org website team wiki page saying something like, "Please read the Website Team's" information page to learn about the team, including tools, technologies, and languages we use and our meeting times", I think the Technologies Used section could be omitted.
  • Info for Meetings section, and "Wait until your pull request is merged before working on another issue." could probably be moved to the Web Developer wiki page.
    • Though, a better option might be to link to the info in section 2.1 Hack for LA in CONTRIBUTING.md in the Web Developer wiki page because the meetings and the info about prs are already in section 2.1.

- Remove 'Optional' from developer office hours meeting 
- Change 'Announcements' to 'Time Off'
@JessicaLucindaCheng

This comment was marked as outdated.

Copy link
Member

@JessicaLucindaCheng JessicaLucindaCheng left a comment

Choose a reason for hiding this comment

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

@vraer LGTM!

@JessicaLucindaCheng JessicaLucindaCheng merged commit 42d1c25 into main Oct 29, 2023
@vraer vraer deleted the update-about-the-dev-team branch November 10, 2023 02:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants