Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 14 additions & 15 deletions docs/gemstones/00-gh_cli_installation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Installing and Setting Up GitHub CLI on Rocky Linux 9.3
title: Installing and Setting Up GitHub CLI on Rocky Linux
author: Wale Soyinka
tags:
- GitHub CLI
Expand All @@ -10,7 +10,7 @@ tags:

## Introduction

This gemstone covers the installation and basic setup of the GitHub CLI tool (gh) on Rocky Linux 9.3, enabling users to interact with GitHub repositories directly from the command line.
This gemstone covers the installation and basic setup of the GitHub CLI tool (gh) on Rocky Linux system, enabling users to interact with GitHub repositories directly from the command line.

## Problem Description

Expand All @@ -23,24 +23,25 @@ Users need a convenient way to interact with GitHub without leaving the command
- Basic familiarity with command line operations
- An existing Github account

## Proceedure
## Procedure

1. **Install GitHub CLI Using Script**:
1. **Install GitHub CLI repo using curl**:
Use the curl command to download the official repository file for `gh`. The downloaded file will be saved under the /etc/yum.repos.d/ directory. After downloading, use the dnf command to install `gh` from the repository. Type:
```

```bash
curl -fsSL https://cli.github.com/packages/rpm/gh-cli.repo | sudo tee /etc/yum.repos.d/github-cli.repo
sudo dnf -y install gh
```

2. **Verify Installation**:
Ensure that `gh` is correctly installed.
```
Ensure that `gh` is correctly installed. Type:

```bash
gh --version
```

3. **Authenticate with GitHub**:
Log in to your GitHub account.
```
Log in to your GitHub account. Type:

```bash
gh auth login
```
Follow the prompts to authenticate.
Expand All @@ -51,7 +52,5 @@ You should now have the GitHub CLI installed and set up on your Rocky Linux 9.3

## Additional Information (Optional)

- GitHub CLI provides various commands like `gh repo clone`, `gh pr create`, `gh issue list`, etc.
- For more detailed usage, refer to the [official GitHub CLI documentation](https://cli.github.com/manual/).


- GitHub CLI provides various commands like `gh repo clone`, `gh pr create`, `gh issue list`, and so on.
- For more detailed usage, refer to the [official GitHub CLI documentation](https://cli.github.com/manual/).
5 changes: 2 additions & 3 deletions docs/gemstones/01-gh_cli_1st_pr.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@

---
title: 1st time contribution to Rocky Linux Documentation via CLI
author: Wale Soyinka
contributors: [List of Contributors]
contributors:
tags:
- GitHub
- Rocky Linux
Expand All @@ -13,7 +12,7 @@ tags:

## Introduction

This guide details how to contribute to the Rocky Linux documentation using only the command line interface (CLI). It covers forking the repository and creating a pull request.
This Gemstone details how to contribute to the Rocky Linux documentation project using only the command line interface (CLI). It covers forking the repository the 1st time and creating a pull request.
We'll use contributing a new Gemstone document in our example.

## Problem Description
Expand Down
49 changes: 49 additions & 0 deletions docs/gemstones/02-gh_cli_edit_pr_title.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: Editing or Changing the Title of an Existing Pull Request via CLI
author: Wale Soyinka
contributors:
tags:
- GitHub
- Pull Request
- Documentation
- CLI
---

## Introduction

This guide explains how to edit or change the title of an existing pull request (PR) in a GitHub repository, using both the GitHub web interface and CLI.

## Problem Description

Sometimes, there may be a need to modify the title of a PR after its creation to better reflect the current changes or discussions.

## Prerequisites

- An existing GitHub pull request.
- Access to GitHub web interface or CLI with necessary permissions.

## Procedure

### Using the GitHub CLI

1. **Check Out the Corresponding Branch**:
- Ensure you are on the branch associated with the PR.
```bash
git checkout branch-name
```

2. **Edit the PR Using the CLI**:
- Use the following command to edit the PR:
```bash
gh pr edit PR_NUMBER --title "New PR Title"
```
- Replace `PR_NUMBER` with the number of your pull request and `"New PR Title"` with the desired title.

## Additional Information (Optional)

- Editing a PR title will not affect its discussion thread or code changes.
- It's considered good practice to inform collaborators if significant changes are made to a PR title.

## Conclusion

By following these steps, you can easily change the title of an existing pull request in a GitHub repository, through the GitHub CLI tool (gh).
44 changes: 44 additions & 0 deletions docs/gemstones/02_github_web_edit_pr_title.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Editing or Changing the Title of an Existing Pull Request via github.com
author: Wale Soyinka
contributors:
tags:
- GitHub
- Pull Request
- Documentation
---

## Introduction

This guide explains how to edit or change the title of an existing pull request (PR) in a GitHub repository, using the GitHub web interface.

## Problem Description

Sometimes, there may be a need to modify the title of a PR after its creation to better reflect the current changes or discussions.

## Prerequisites

- An existing GitHub pull request.
- Access to GitHub web interface or CLI with necessary permissions.

## Procedure

### Using the GitHub Web Interface

1. **Navigate to the Pull Request**:
- Go to the repository where the PR is located.
- Click on 'Pull requests' and select the PR you want to edit.

2. **Edit the PR Title**:
- Click on the title of the PR.
- An editable text box will appear.
- Modify the title as needed and press 'Enter' or click outside the text box to save changes.

## Additional Information (Optional)

- Editing a PR title will not affect its discussion thread or code changes.
- It's considered good practice to inform collaborators if significant changes are made to a PR title.

## Conclusion

By following these steps, you can easily change the title of an existing pull request in a GitHub repository, through the web interface.
44 changes: 44 additions & 0 deletions docs/gemstones/gemstone_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Title of the Gemstone
author: Author's Name
contributors: [Comma seperated list of contributors]
tags:
- List
- Of
- Relevant
- Tags
---

## Introduction

Brief overview of the topic. State the relevance and purpose of the Gemstone.

## Problem Description

Define the problem or challenge addressed.

## Prerequisites

List prerequisites:
- Background knowledge
- Tools or software needed

## Procedure

Outline the procedure or solution with numbered steps:

1. **First Step**:
Instructions and command examples.
```bash
Command or code snippet
```
2. **Second Step**:
Continue with detailed instructions.

## Additional Information (Optional)

Include tips, alternative methods, or insights.

## Conclusion

Summarize the outcome and reinforce the guide's value.