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 git workflow documentation to wiki #563

Open
monikkaelyse opened this issue Feb 3, 2025 · 7 comments
Open

Add git workflow documentation to wiki #563

monikkaelyse opened this issue Feb 3, 2025 · 7 comments

Comments

@monikkaelyse
Copy link
Collaborator

The Techtonica Git Workflow documentation is currently in a Google doc. This should be moved into our Techtonica Wiki.

Please make sure formatting is correct for the sections that are markdown (Best Practices for Creating a GitHub Issue and Pull Request Template).

Please also feel free to proofread and correct any mistakes, or add anything that may be missing.

@mai-repo
Copy link
Collaborator

mai-repo commented Feb 3, 2025

Status Update: Grabbed Ticket!

@MaggieFero
Copy link
Collaborator

Commenting so I can follow this issue! I'll wait until the doc moves into the Wiki for the review we discussed in the Slack thread.

@mai-repo mai-repo removed their assignment Feb 6, 2025
@mai-repo
Copy link
Collaborator

mai-repo commented Feb 6, 2025

Status Update: Un-assigning myself to this ticket to work on creating localStorage for another ticket.

@mai-repo mai-repo self-assigned this Feb 13, 2025
@mai-repo
Copy link
Collaborator

mai-repo commented Feb 26, 2025

Migrate Techtonica Git Workflow Documentation to Wiki

Description

This PR addresses the need to migrate the Techtonica Git Workflow documentation into the Wiki. It includes the following changes:

  • All content from the Google Doc has been successfully moved into the Wiki.
  • Markdown sections, specifically Best Practices for Creating a GitHub Issue and Pull Request Template, have been correctly formatted.
  • Proofreading was done to correct any mistakes, and additional details were added where necessary.
  • A sidebar has been created for the Git Workflow to enhance navigation and accessibility.

This update aims to make the Git Workflow documentation easier to access, maintain, and reference for current and future team members.

Changes & Updates

  • Migrated content from the Google Doc to the Wiki.
  • Ensured correct formatting, including markdown sections for:
    • Best Practices for Creating a GitHub Issue
    • Pull Request Template
  • Proofread the content, corrected any mistakes, and filled in any missing details.
  • Created a sidebar for the Git Workflow to improve navigation.

Visual

Image

Objective

Move the Techtonica Git Workflow documentation from the Google Doc to the Techtonica Wiki while ensuring proper formatting, accuracy, and improved navigation.

How to Review

  • Check the Wiki to confirm content is formatted correctly.
  • Verify that the markdown sections render properly.
  • Review for accuracy and completeness.

Reviewers: @monikkaelyse, @mx-ruthie, and @daaimah123 please focus your review on the wiki.

@mai-repo
Copy link
Collaborator

Status Update: Notify reviewers of the finished ticket.

@daaimah123
Copy link
Collaborator

This looks good, @mai-repo

Request for change:
I am not keen on the git workflow table of contents directly under the pages section as it feels redundant with the pages section in the same right hand panel offering the same information across the wiki navigation. I haven't seen what that section looks like with other things such as incoming documentation for styling best practices, the inclusion of which could potentially look better.

  • For now, please remove the "Git Workflow Table of Contents" section.
  • Unless you can share how this will be useful as well as provide support with additional similarly group table of contents in the sidebar.

Since this workflow is different from what you all have been using, I'd like a review from each returning graduate in the cohort to confirm they have read through, reviewed, and understand the new workflow (@jsnorek @ChasVanDav @stmcpeters @themagicianking)

Image

@ChasVanDav
Copy link
Collaborator

@mai-repo nice work! @daaimah123 confirming I have read and understood the Git work flow.

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

No branches or pull requests

5 participants