feat: adds glossary #211

Lymah123 · 2023-11-20T22:54:58Z

Description

This is the submission to issue Feature: Add glossary to getting started section #200

What type of PR is this? (check all applicable)

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings

Added tests?

👍 yes
🙅 no, because they aren't needed
🙋 no, because I need help

Added to documentation?

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

Link redirects user to an unavailable page: Issue #181

netlify · 2023-11-20T22:55:02Z

👷 Deploy request for docs-open pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	`16b7732`

github-actions

PR Compliance Checks

Thank you for your Pull Request! We have run several checks on this pull request in order to make sure it's suitable for merging into this project. The results are listed in the following section.

Issue Reference

In order to be considered for merging, the pull request description must refer to a specific issue number. This is described in our Contributing Guide.
This check is looking for a phrase similar to: "Fixes #XYZ" or "Resolves #XYZ" where XYZ is the issue number that this PR is meant to address.

Protected Branch

In order to be considered for merging, the pull request changes must not be implemented on the "main" branch. This is described in our Contributing Guide. We would suggest that you close this PR and implement your changes as described in our Contributing Guide and open a new pull request.

Lymah123 · 2023-11-20T22:59:46Z

Hi @BekahHW and @CBID2 , I fixed the conflicting files with this PR.

Lymah123 · 2023-11-20T23:38:27Z

Hi, @BekahHW and @CBID2, you can now review. I will be waiting!

Thank you.

CBID2 · 2023-11-21T02:15:19Z

Hi @BekahHW and @CBID2 , I fixed the conflicting files with this PR.

Hi @Lymah123. Can you add the issue number to the `Related Documents and Tickets" section instead of the Description? It'll make it easier for the PR and issue to close.

CBID2

Looks great @Lymah123! :)

Lymah123 · 2023-11-21T10:13:07Z

Hi @BekahHW and @CBID2 , I fixed the conflicting files with this PR.

Hi @Lymah123. Can you add the issue number to the `Related Documents and Tickets" section instead of the Description? It'll make it easier for the PR and issue to close.

Hi @CBID2, how do you mean? I didn't get that.

adiati98 · 2023-11-21T11:27:03Z

@Lymah123 you added a setting-up-a-new-repository.md here. I don't think that it is part of the newest Maintainer section.

@BekahHW can you confirm this?

adiati98 · 2023-11-21T12:25:18Z

docs/contributing/technical/resolve-merge-conflicts.md

@@ -11,6 +11,11 @@ Pretty often when opening a pull request it is very likely to run into merge con
 To better illustrate the commands listed here at will use commits and screenshots from [open-sauced#1078](https://github.com/open-sauced/open-sauced/pull/1078).


+## Repository setup


@Lymah123 There is a duplication of this title in line 19. Which one do you want to keep?

Also, let's use capital letters for titles. :)

Suggested change

## Repository setup

## Repository Setup

adiati98

Hi @Lymah123,
I've left some feedback for you here. :)

Also, I pulled your branch and noticed that you worked on your changes on the main branch.
Please read the PR Compliance Check in the "Protected Branch" section.

Therefore, as per PR Complience Check, I suggest that you:

Create a new branch and make your changes there.
Close this PR and create a new PR.

adiati98 · 2023-11-21T12:38:41Z

docs/community/glossary.md

@@ -0,0 +1,33 @@
+# OpenSauced Glossary


The heading 1 comes from the data. So let's add the data here and not a heading:

Suggested change

# OpenSauced Glossary

---

id: glossary

title: 'OpenSauced Glossary'

sidebar_label: 'OpenSauced Glossary'

keywords:

- glossary

---

adiati98 · 2023-11-21T12:40:46Z

docs/community/glossary.md

+## PR Velocity
+The PR Velocity measures the percentage and amount of days that pull requests that are merged. It is a great way to track the progress of your open source contributions.


Let's add a space between the title and paragraph here.
Besides that it is the best practice, we will do this going forward for consistency.

Suggested change

## PR Velocity

The PR Velocity measures the percentage and amount of days that pull requests that are merged. It is a great way to track the progress of your open source contributions.

## PR Velocity

The PR Velocity measures the percentage and amount of days that pull requests that are merged. It is a great way to track the progress of your open source contributions.

Lymah123 · 2023-11-21T13:35:29Z

@Lymah123 you added a setting-up-a-new-repository.md here. I don't think that it is part of the newest Maintainer section.

@BekahHW can you confirm this?

Hi @adiati98 , I didn't change anything from that file. I only touched it due to merge conflicts I had.

adiati98 · 2023-11-21T14:02:41Z

@Lymah123 in that case, I believe it was one of the files from previous version of Maintainers Guide before @BekahHW's newest version.

And because you made changes directly in the main branch and need to create new branch, let's close this PR and start all fresh! 🙂

The main branch of your forked repository also contains your latest changes, which we need to remove.

Steps

Here's what you can do:

Delete your forked repository. --> deleting your forked repository won't affect the original repository.
Delete your local repository.
Fork the docs repository.
Clone the repository locally.
Create a new branch where you will work on your changes.
Create a glossary.md in the community folder and copy-paste the content from the file in this PR. Please also refer to the feedback reviews for the revisions.
Add the page to sidebar.js.
Add, commit, push, and create a new PR.

Lymah123 and others added 15 commits October 2, 2023 12:10

Terminology not clear

5d07e79

Update setting-up-a-new-repository.md

db86f39

Update setting-up-a-new-repository.md

4ce5169

Update setting-up-a-new-repository.md

0bc22c4

Update resolve-merge-conflicts.md

409ffcb

Update setting-up-a-new-repository.md

f45fdca

Update introduction-to-contributing.md

14866dd

Link redirects user to an unavailable page: Issue #181

Merge branch 'main' into main

a23389b

Update resolve-merge-conflicts.md

cdfa3c6

Update setting-up-a-new-repository.md

197f598

Update resolve-merge-conflicts.md

bc7049b

Add line back in.

6a7b435

adds glossary to OpenSauced's docs

004b1ce

adds glossary

4c71f22

fixes merge conflicts

0421f1a

github-actions bot reviewed Nov 20, 2023

View reviewed changes

Lymah123 changed the title ~~bug : fixes merge conflict~~ fix: fixes merge conflict Nov 20, 2023

adds-glossary

16b7732

Lymah123 changed the title ~~fix: fixes merge conflict~~ feat: adds glossary Nov 20, 2023

CBID2 assigned Lymah123 Nov 21, 2023

CBID2 added the 📝 documentation label Nov 21, 2023

CBID2 approved these changes Nov 21, 2023

View reviewed changes

CBID2 added the 💡 feature A label to note if work is a feature label Nov 21, 2023

Lymah123 changed the title ~~feat: adds glossary~~ feat: adds glossary Nov 21, 2023

adiati98 reviewed Nov 21, 2023

View reviewed changes

adiati98 requested changes Nov 21, 2023

View reviewed changes

adiati98 closed this Nov 21, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: adds glossary #211

feat: adds glossary #211

Lymah123 commented Nov 20, 2023 •

edited

Loading

netlify bot commented Nov 20, 2023 •

edited

Loading

github-actions bot left a comment •

edited

Loading

Lymah123 commented Nov 20, 2023

Lymah123 commented Nov 20, 2023

CBID2 commented Nov 21, 2023 •

edited

Loading

CBID2 left a comment

Lymah123 commented Nov 21, 2023

adiati98 commented Nov 21, 2023

adiati98 Nov 21, 2023 •

edited

Loading

adiati98 left a comment •

edited

Loading

adiati98 Nov 21, 2023

adiati98 Nov 21, 2023

Lymah123 commented Nov 21, 2023

adiati98 commented Nov 21, 2023

		@@ -11,6 +11,11 @@ Pretty often when opening a pull request it is very likely to run into merge con
		To better illustrate the commands listed here at will use commits and screenshots from [open-sauced#1078](https://github.com/open-sauced/open-sauced/pull/1078).


		## Repository setup

-# OpenSauced Glossary
+---
+id: glossary
+title: 'OpenSauced Glossary'
+sidebar_label: 'OpenSauced Glossary'
+keywords:
+  - glossary
+---

		## PR Velocity
		The PR Velocity measures the percentage and amount of days that pull requests that are merged. It is a great way to track the progress of your open source contributions.

feat: adds glossary #211

feat: adds glossary #211

Conversation

Lymah123 commented Nov 20, 2023 • edited Loading

Description

What type of PR is this? (check all applicable)

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings

Added tests?

Added to documentation?

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

netlify bot commented Nov 20, 2023 • edited Loading

👷 Deploy request for docs-open pending review.

github-actions bot left a comment • edited Loading

Choose a reason for hiding this comment

PR Compliance Checks

Issue Reference

Protected Branch

Lymah123 commented Nov 20, 2023

Lymah123 commented Nov 20, 2023

CBID2 commented Nov 21, 2023 • edited Loading

CBID2 left a comment

Choose a reason for hiding this comment

Lymah123 commented Nov 21, 2023

adiati98 commented Nov 21, 2023

adiati98 Nov 21, 2023 • edited Loading

Choose a reason for hiding this comment

adiati98 left a comment • edited Loading

Choose a reason for hiding this comment

adiati98 Nov 21, 2023

Choose a reason for hiding this comment

adiati98 Nov 21, 2023

Choose a reason for hiding this comment

Lymah123 commented Nov 21, 2023

adiati98 commented Nov 21, 2023

Steps

Lymah123 commented Nov 20, 2023 •

edited

Loading

netlify bot commented Nov 20, 2023 •

edited

Loading

github-actions bot left a comment •

edited

Loading

CBID2 commented Nov 21, 2023 •

edited

Loading

adiati98 Nov 21, 2023 •

edited

Loading

adiati98 left a comment •

edited

Loading