Skip to content
This repository has been archived by the owner on Aug 7, 2024. It is now read-only.

Updated the QuickStart-JSON documentation with new BioDrop images #9714

Merged
merged 34 commits into from
Nov 5, 2023
Merged
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
751e61a
updated step2 img
goobric Nov 1, 2023
411cd31
updated step5 img
goobric Nov 1, 2023
264a37d
updated step7 img
goobric Nov 1, 2023
437f283
updated step17 img
goobric Nov 1, 2023
16cff3e
updated text in step7 to reflect the image used in step7
goobric Nov 1, 2023
25acd74
updated text in step7 for example user
goobric Nov 1, 2023
474a492
corrected typo in step7
goobric Nov 1, 2023
e6a8a33
updated step8 clipboard text
goobric Nov 1, 2023
8a847b3
upadated step9 clipboard text
goobric Nov 1, 2023
1960c53
updated step9 links text
goobric Nov 1, 2023
a9b0c97
created images directory
goobric Nov 1, 2023
5bf5cb5
add images for step5
goobric Nov 1, 2023
6e436bc
added image for step4 -04
goobric Nov 1, 2023
7f244ce
image for step5
goobric Nov 1, 2023
e9d9f1f
image for step9
goobric Nov 1, 2023
0d4359c
added image for step12
goobric Nov 1, 2023
1d00a5d
amended step10 text for new image in step12
goobric Nov 1, 2023
d08ee6f
added red border to propose new file
goobric Nov 1, 2023
dad597e
amended text in step12 for new image in step12
goobric Nov 1, 2023
7d4940f
added new image for step15
goobric Nov 1, 2023
f23c389
new image for step15
goobric Nov 1, 2023
d65e5c5
new link for image for step15
goobric Nov 1, 2023
6f1312d
updated text for step19
goobric Nov 2, 2023
4b6fc7e
removed image associated with step19
goobric Nov 2, 2023
6e52c40
added gh img link to step3, removed_03 img from images
goobric Nov 3, 2023
7b085b5
add gh img link step4, removed _04 img
goobric Nov 3, 2023
3e4b6bb
add gh img link step5, removed _05 img
goobric Nov 3, 2023
d3f0a6e
add gh img link step12, removed _e5f8 img
goobric Nov 3, 2023
fd47059
add gh img link step15, removed _15 img
goobric Nov 3, 2023
9f9bb80
removed images dir from docs
goobric Nov 3, 2023
b69d33e
added original image for step19
goobric Nov 3, 2023
ca13f1e
updated img link for step9
goobric Nov 3, 2023
1a6cd7e
Update pages/docs/quickstart-json.mdx
eddiejaoude Nov 5, 2023
161621e
Update pages/docs/quickstart-json.mdx
eddiejaoude Nov 5, 2023
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
71 changes: 38 additions & 33 deletions pages/docs/quickstart-json.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,40 +36,42 @@ To do this, you need a GitHub account. If you do not have one yet, you can creat
1. Log in to your GitHub Account
2. Visit the <Link target="_blank" href="https://github.com/EddieHubCommunity/BioDrop">BioDrop repo</Link>

![BioDrop GitHub repo](https://user-images.githubusercontent.com/82668196/208292176-fb2bedf9-8dd1-4fff-b422-30d54f2fdd48.png)
![BioDrop GitHub repo](https://github.com/EddieHubCommunity/BioDrop/assets/624760/e00b3df3-f55e-46ca-bb02-9e3603947f48)

3. If you wish to be kept up to date with the repo, hit that "Star" at the top right

![Start BioDrop](https://user-images.githubusercontent.com/51131670/210128265-8a23977a-e80e-4037-b94b-253f5a23b8e7.png)
![Start BioDrop](https://github.com/EddieHubCommunity/BioDrop/assets/23141638/53747c7b-5948-434a-be92-eb58ab26a74b)

4. Click on Fork

![create a new fork](https://user-images.githubusercontent.com/51131670/210128263-0716b260-5922-4db3-933d-f7e992b668a9.png)
![create a new fork](https://github.com/EddieHubCommunity/BioDrop/assets/23141638/d6e7b2df-e7d8-4877-aea5-9821bc8df904)

5. Accept the default fork creating a copy of the BioDrop project in your account - this will take you to the forked repo
5. Accept the default fork name, click on 'Create fork'. A forked copy of the BioDrop project is now open in your GitHub account

![BioDrop form](https://user-images.githubusercontent.com/82668196/208292178-92daccad-293d-407a-9d8d-0a86b63d6bd7.png)
![Forked BioDrop](https://github.com/EddieHubCommunity/BioDrop/assets/23141638/d1b74078-9905-42e7-9b4b-b8c40ebf8425)

![BioDrop form](https://github.com/EddieHubCommunity/BioDrop/assets/624760/4985be8d-67a4-4eb3-ab1b-3e666089c707)

6. Click add file and select "create new file"

![Create new file](https://user-images.githubusercontent.com/51131670/210201815-9c56ca28-19e8-4ef9-9934-6014d5262624.png)

7. In the file path at the top, add `data/` followed by your GitHub username, exactly as it appears including capitalisation, and then append `.json` to it.
7. In the file path at the top, add `data/` followed by your GitHub username, exactly as it appears including capitalisation if any, and then append `.json` to it.

For example for username **"SaraJaoude"**:
For example for username **"eddiejaoude"**:

> - _**Correct**_: `BioDrop/data/SaraJaoude.json` (including capitalisation in filename)
> - _**Incorrect**_: `BioDrop/data/sarajaoude.json` (filename capitalisation does not match username capitalisation)
> - _**Correct**_: `BioDrop/data/eddiejaoude.json` (this example: no capitalisation in filename)
> - _**Incorrect**_: `BioDrop/data/EddieJaoude.json` (filename capitalisation does not match username)

![create json file](https://user-images.githubusercontent.com/82668196/208292180-e0caee14-5eb3-42f1-9035-dabae4ce84f6.png)
![create json file](https://github.com/EddieHubCommunity/BioDrop/assets/624760/0f837e97-b079-4380-b451-8dfe23206842)

8. For the file contents use the json structure below:

<ClipboardCopy>
```js
{
"name": "Sara Jaoude",
"bio": "Lawyer turned **Digital Nomad**. Travel enthusiast Yoga & Peloton aficionado"
"name": "Eddie Jaoude",
"bio": "Open Source DevRel | Founder of **EddieHub** and [BioDrop](https://biodrop.io) | **GitHub** Star"
}
```
</ClipboardCopy>
Expand All @@ -84,13 +86,14 @@ For example for username **"SaraJaoude"**:
<ClipboardCopy>
```js
{
"name": "Sara Jaoude",
"bio": "Lawyer turned **Digital Nomad**. Travel enthusiast Yoga & Peloton aficionado",
"name": "Eddie Jaoude",
"bio": "Open Source DevRel | Founder of **EddieHub** and [BioDrop](https://biodrop.io) | **GitHub** Star",
"links": [
{
"name": "Follow me on Twitter",
"url": "https://twitter.com/SaraJaoude",
"icon": "FaTwitter"
"group": "Business",
"name": "Business: DevRel Services",
"url": "http://eddiejaoude.io",
"icon": "FaLink"
}
]
}
Expand All @@ -105,28 +108,31 @@ _note: do not have duplicate links (url)_
| url | string | Full url to the resource |
| icon | string | The icon you would like displayed. We support the following icon sets: **Fa** and **Si** from React Icons. You can search available [icons](https://biodrop.io/icons) |

![propose new file](https://user-images.githubusercontent.com/82668196/244908686-6f5727c7-b7a1-414b-8ec0-372e8fc287e8.png)
![propose new file](https://user-images.githubusercontent.com/82668196/279686426-e47b89c9-f28e-4f06-a2d2-94a69bb386e2.png)

To add more links, add another object inside the links collection. For example:

<ClipboardCopy>
```js
"links": [
{
"name": "Follow me on Twitter",
"url": "https://twitter.com/SaraJaoude",
"icon": "FaTwitter"
"group": "Business",
"name": "Business: DevRel Services",
"url": "http://eddiejaoude.io",
"icon": "FaLink"
},
{
"name": "Follow me on Instagram",
"url": "https://www.instagram.com/eddieandsaraexplore/",
"icon": "FaInstagram"
}
]
"group": "Socials Primary",
"name": "Twitter: Follow me",
"url": "https://twitter.com/eddiejaoude",
"icon": "FaTwitter",
"color": "#00ACEE"
},
]
```
</ClipboardCopy>

10. Scroll to the bottom and commit new file by adding the commit message that starts `data: ` followed by your GitHub username (for example `data: SaraJaoude`)
10. Scroll to the bottom and commit new file by adding the commit message that starts `data: ` followed by your GitHub username (for example `data: eddiejaoude`)

You can skip `optional extended message`

Expand All @@ -142,9 +148,9 @@ You can skip `optional extended message`
/>

11. Click `create new branch` and you can use the default name provided
12. Then, click `Propose new file`
12. Then, click `Propose changes`

![propose new file](https://user-images.githubusercontent.com/94740455/227761922-50d8484d-7c60-49a2-8347-941de2252c64.png)
![propose new file](https://github.com/EddieHubCommunity/BioDrop/assets/23141638/8b21ad42-3648-4cf8-a76e-909b0af636f1)

<Alert
type="warning"
Expand All @@ -170,22 +176,21 @@ The first dropdown for the `base` repository (destination) should be set to `Edd
14. Click `Create pull request`
15. The description will be filled with a template, please fill in the appropriate sections

![create pull request](https://user-images.githubusercontent.com/82668196/208292192-704402e7-c2d6-432e-8dab-cb6a678866c1.png)
![create pull request](https://github.com/EddieHubCommunity/BioDrop/assets/23141638/2835ed3c-c305-404d-8294-8bde72a937f2)

16. Click `Create pull request`

17. Now you need to wait to have your Pull Request (changes) reviewed

![pull request](https://user-images.githubusercontent.com/82668196/208292196-c374d328-6bed-4f7b-adbc-b55c29b7c367.png)
![pull request](https://github.com/EddieHubCommunity/BioDrop/assets/624760/806b369d-4e8f-442b-be35-802a71afaed8)

An approving review from one of BioDrop's maintainers will show a green check mark next to their id.

![maintainer review](https://user-images.githubusercontent.com/35927536/217060602-ba3678d1-f655-4805-a47d-e40f1ddcd59f.png)

18. You will receive a GitHub notification when you have a comment, review, or your Pull Request has been merged
19. Once merged, your profile will be available a few minutes later on your custom URL (<Link href="https://biodrop.io/SaraJaoude">BioDrop.io/SaraJaoude</Link>)
19. Once merged, your profile will be available a few minutes later, with your custom BioDrop URL <Link href="https://biodrop.io/eddiejaoude">BioDrop.io/eddiejaoude </Link>

![merged pull request](https://user-images.githubusercontent.com/82668196/208292199-e7a01541-5356-4b2f-8b3e-94be121c661f.png)

## Example Profiles

Expand Down