Skip to content

Home

Jump to bottom
Caffery Yang edited this page Feb 16, 2023 · 1 revision

Welcome to the CINEMA-Group wiki!

Updating Information in the CINEMA Research Group Repository

This tutorial will guide you through the process of updating information in the CINEMA Research Group repository using GitHub Desktop.

Prerequisites

Before you start, make sure you have the following:

  • A GitHub account
  • Access to the Hugo Research Group repository
  • GitHub Desktop installed on your computer

Updating Your Information

  1. Open GitHub Desktop and sign in to your GitHub account.
  2. Clone the Hugo Research Group repository to your local computer by clicking the "Clone or Download" button on the repository page and selecting "Open in Desktop".
  3. Locate the folder with your name in the content/authors folder of the repository. This folder contains information about you in the research group.
  4. Open the index.md file in the folder in a text editor and find your information. You can update your information by modifying the relevant fields (e.g. name, email, etc.).
  5. Once you have made the necessary changes, save the file.
  6. In GitHub Desktop, select the repository and navigate to the "Changes" tab. You should see the changes you made to the index.md file.
  7. In the "Summary" field, enter a brief description of the changes you made (e.g. "Updated my information").
  8. Click the "Commit to main" button to commit the changes to the repository.
  9. To push the changes to the remote repository, click the "Push origin" button in the upper right corner.

Updating Other People's Information

If you need to update information about other people in the research group, follow the same steps as described above, but make sure to obtain their permission before making any changes.

Contributing to the Repository

To contribute to the repository, you can follow these steps:

  1. Open GitHub Desktop and sign in to your GitHub account.
  2. Clone the Hugo Research Group repository to your local computer by clicking the "Clone or Download" button on the repository page and selecting "Open in Desktop".
  3. Make the necessary changes to the files in the repository.
  4. In GitHub Desktop, select the repository and navigate to the "Changes" tab. You should see the changes you made to the files.
  5. In the "Summary" field, enter a brief description of the changes you made (e.g. "Fixed a typo in the README file").
  6. Click the "Commit to main" button to commit the changes to the repository.
  7. To push the changes to the remote repository, click the "Push origin" button in the upper right corner.
  8. Create a pull request on the remote repository to request that your changes be merged into the main branch.

Content Folder Explanation

The content folder in the Hugo Research Group repository appears to contain several sub-folders, each with a specific purpose. Here is a brief explanation of each sub-folder:

  • admin: This folder likely contains content for the administrative pages of the website, such as contact information for the research group.

  • authors: This folder likely contains information about the authors in the research group, including their names, biographies, and contact information.

  • contact: This folder likely contains content for the contact page of the website, such as the research group's address and email address.

  • event: This folder likely contains information about events related to the research group, such as seminars and conferences.

  • home: This folder likely contains content for the home page of the website, such as an introduction to the research group and its mission.

  • people: This folder likely contains information about the people in the research group, including their names, biographies, and contact information.

  • post: This folder likely contains content for the research group's blog, including articles and updates.

  • publication: This folder likely contains information about the research group's publications, including papers, books, and conference proceedings.

  • tour: This folder likely contains information about tours related to the research group, such as laboratory tours and research site visits.

Each of these sub-folders likely contains files in a specific format, such as Markdown or HTML, that define the content for the corresponding pages on the website. The Hugo platform uses these files to build the website and generate the corresponding pages.

How to Pull a Request

To create a pull request using GitHub Desktop, follow these steps:

  1. Open GitHub Desktop and sign in to your GitHub account.
  2. Clone the repository that you want to contribute to to your local computer by clicking the "Clone or Download" button on the repository page and selecting "Open in Desktop".
  3. Make the necessary changes to the files in the repository.
  4. In GitHub Desktop, select the repository and navigate to the "Changes" tab. You should see the changes you made to the files.
  5. In the "Summary" field, enter a brief description of the changes you made (e.g. "Fixed a typo in the README file").
  6. Click the "Commit to main" button to commit the changes to the repository.
  7. To push the changes to the remote repository, click the "Push origin" button in the upper right corner.
  8. In the GitHub Desktop menu, select "Branch" and then "Create Pull Request".
  9. In the "Create Pull Request" dialog, select the target branch that you want to merge your changes into (usually "main").
  10. Enter a title and description for the pull request that describes the changes you made and why they should be merged into the target branch.
  11. Click the "Create Pull Request" button to create the pull request.

Clone this wiki locally