Documentation
Here you should find everything you need from getting started with creating your Profile to more advanced topics. We welcome contributions, check out the LinkFree Repo and the documentation source on GitHub for more information.
Editing
Edit your profile
There are two types of edits:
- Making new changes then creating a Pull Request
- Adding more changes to an existing open Pull request
New Edits
If you want to edit your profile (for example update a link or remove a link), follow these steps:
- Log into your GitHub Account
- Go to your Repositories
- Then click on the
LinkFree
repo (fork)
- Now we need to make sure your fork is up to date. You can do this by clicking on
Sync fork
and clickUpdate branch
(if available)
- Click
Go to file
and type your GitHub username - Click on your
json
file
- Click the
edit
pencil icon at the top right - Make the changes you require
Changes could include:
- updating your Bio
- adding a new section (see examples below)
Sections | Json object | Description |
---|---|---|
social shortcuts | socials | These are the icons at the top of your Profile |
tags | tags | These are search keywords for people to discover your Profile (for example DevRel or Javascript ) |
milestones | milestones | Milestones you wish to highlight (for example "First day on GitHub") |
testimonials | testimonials | Include testimonials from other people in the community |
Virtual or in person events | events | Show which events you are attending |
For how to add each of these sections, please referring to their relevant guides.
- Scroll to the bottom and commit new file by adding the commit message that starts
data:
followed by your GitHub username (for exampledata: SaraJaoude
)
You can skip optional extended message
- Click
create new branch
and you can use the default name provided - Then click
Propose changes
- Click
compare across forks
and select the destination on the left and the source on the right - Click
Create pull request
- You will see a title and description for the Pull Request, fill these in and click
Create pull request
- Now you need to wait to have your Pull Request (changes) reviewed
An approving review from one of LinkFree's maintainers will show a green check mark next to their id.
- You will receive a GitHub notification when you have a comment, review or your Pull Request has been merged
- Once merged your profile will be available a few minutes later on the same custom url (for example:
https://linkfree.io/SaraJaoude
)
You can learn more about these later on in the documentation, in their respective sections.
Adding more changes to an open Pull Request
The main two reasons for making additional edits to an open Pull Request are:
- GitHub Action failed
- Your Pull Request has received a comment requesting changes
To make further changes to an open Pull Request, follow these steps:
- Go to your open Pull Request
- Click on the tab
Files Changed
- At the top right of the file click on the 3 dots and then click
Edit file
(this will allow you to edit your file in your branch that is in your fork) - Make changes and commit these to the same branch (this should automatically be selected)
GitHub will automatically append these changes to your open Pull Request.