Update Project Profile: [Project Name] Add [Name Of Volunteer]

by ADMIN 63 views

Prerequisites

Before you begin, make sure you meet the following requirements:

Overview

Keeping project information up to date is crucial so that visitors to the website can find accurate information. This guide will walk you through the process of updating a project profile by adding a new volunteer.

Action Items

To update the project profile, follow these steps:

Step 1: Open the Project File

  • In your IDE, open the _projects/[Insert filename].md file.
  • Observe the existing syntax of the front matter block [^1] in the file.

Step 2: Add the New Volunteer Profile

  • Find the leadership variable and add the following profile:
*   Make sure to replace the placeholders with the actual information of the new volunteer.

### Step 3: Verify the Changes

*   Verify the changes by viewing the following in your local environment and include before and after screenshots with your pull request:
    -   [Insert name of project] page [^2]

### Step 4: Update the Initiating ER

*   Once your pull request is merged, go to the initiating ER [^3]
*   Check off this issue under the _Dependency_ section
*   If all the issues in the _Dependency_ section are checked off, move initiating ER [^3] to **Questions / In Review** column and uncheck the **Dependency label**.

    <details>
        <summary>Click here to see how to uncheck the <b>Dependency label</b></summary>
        <img src="https://github.com/hackforla/website/assets/31293603/6f53f4d4-7d2c-45f8-8534-9936fc9adee8" width="300px">
    </details>

**Resources/Instructions**
-------------------------

[^1]: [Info about the front matter block](https://jekyllrb.com/docs/front-matter/)
[^2]: Project detailed info page URL: [Insert project specific page URL here]
[^3]: initiating ER:  #[Insert ER number]

By following these steps, you will be able to update the project profile by adding a new volunteer. Remember to include before and after screenshots with your pull request to verify the changes.<br/>
**Update Project Profile: [Project Name] Add [Name of Volunteer] Q&A**
===========================================================

**Frequently Asked Questions**
---------------------------

### Q: What is the purpose of updating the project profile?

A: Keeping project information up to date is crucial so that visitors to the website can find accurate information. This ensures that the project's progress, leadership, and other relevant details are reflected correctly.

### Q: Who can update the project profile?

A: Only members of Hack for LA can update the project profile. If you are not a member, please follow the steps on our [Getting Started](https://www.hackforla.org/getting-started) page and attend an onboarding session.

### Q: What is the front matter block, and why is it important?

A: The front matter block is a section in the project file that contains metadata about the project. It is essential to understand the syntax of the front matter block to update the project profile correctly.

### Q: How do I add a new volunteer to the project profile?

A: To add a new volunteer, find the `leadership` variable in the project file and add the following profile:
    ```yml
  - name: [Insert leadership member's name]
    github-handle: [Insert GitHub handle]
    role: [Insert role]
    links:
      slack: https://hackforla.slack.com/team/[Insert Slack member ID]
      github: https://github.com/[Insert GitHub handle]
    picture: https://avatars.githubusercontent.com/[Insert GitHub handle]

Make sure to replace the placeholders with the actual information of the new volunteer.

Q: What should I do after updating the project profile?

A: After updating the project profile, verify the changes by viewing the project page in your local environment. Include before and after screenshots with your pull request to ensure that the changes are accurate.

Q: How do I update the initiating ER?

A: Once your pull request is merged, go to the initiating ER and check off this issue under the Dependency section. If all the issues in the Dependency section are checked off, move initiating ER to Questions / In Review column and uncheck the Dependency label.

Q: What if I encounter any issues during the process?

A: If you encounter any issues during the process, please refer to our How to Contribute to Hack for LA Guide for troubleshooting tips. You can also reach out to the Hack for LA community for assistance.

Additional Resources

By following these steps and referring to the additional resources, you will be able to update the project profile by adding a new volunteer. If you have any further questions or concerns, please don't hesitate to reach out to the Hack for LA community.