Browse Source

fixed broken links and updated link text

pull/96/head
jmf 2 months ago
parent
commit
d2143a6596
Signed by: jmf <jmf@lollipopcloud.solutions> GPG Key ID: 5F74BD822DD3B009
2 changed files with 31 additions and 31 deletions
  1. 15
    15
      for-beginners/for-beginners.md
  2. 16
    16
      for-beginners/how-to-gitea.md

+ 15
- 15
for-beginners/for-beginners.md View File

@@ -1,9 +1,9 @@
1 1
 # Introduction
2 2
 
3
-The Lollipop is a [single-board computer (SBC) (link)](https://en.wikipedia.org/wiki/Single-board_computer) cloud device, with the ability to manage your own cellular internet, wifi, VPN, firewall, web server, data backup and syncing, ad blocker, notes and project management, git, RSS feeds, "read it later" bookmark management, GPS mapping, and more. Some of these features (like GPS and cellular internet) require extra hardware, but the base device consists of an SBC with an SD memory card loaded with Armbian.
3
+The Lollipop is a [single-board computer (SBC)](https://en.wikipedia.org/wiki/Single-board_computer) cloud device, with the ability to manage your own cellular internet, wifi, VPN, firewall, web server, data backup and syncing, ad blocker, notes and project management, git, RSS feeds, "read it later" bookmark management, GPS mapping, and more. Some of these features (like GPS and cellular internet) require extra hardware, but the base device consists of an SBC with an SD memory card loaded with Armbian.
4 4
 
5 5
 # Getting Started
6
-You will need a single-board computer (SBC) like an [Orange Pi (link)](http://www.orangepi.org/).
6
+You will need a single-board computer (SBC) like an [Orange Pi](http://www.orangepi.org/).
7 7
 
8 8
 For the basic start up and set up of your Orange Pi, you will need one of the following configurations:
9 9
 
@@ -15,15 +15,15 @@ __NOTE:__ If you are going to use your SBC wirelessly as a server and a client (
15 15
 You will also need an SD card formatted with Armbian installed.
16 16
 
17 17
 ## Installing Armbian on an SD card
18
-[Armbian](https://www.armbian.com/) is a Linux operating system based on Debian and Ubuntu, specifically designed for [ARM boards (link)](https://en.wikipedia.org/wiki/ARM_architecture).
18
+[Armbian](https://www.armbian.com/) is a Linux operating system based on Debian and Ubuntu, specifically designed for [ARM boards](https://en.wikipedia.org/wiki/ARM_architecture).
19 19
 
20
-__NOTE:__ Raspberry Pi 3 users will need to use [Raspbian (link)](https://www.raspberrypi.org/downloads/raspbian/) instead of Armbian.
20
+__NOTE:__ Raspberry Pi 3 users will need to use [Raspbian](https://www.raspberrypi.org/downloads/raspbian/) instead of Armbian.
21 21
 
22
-You will need to [download Armbian (link)](https://dl.lollipopcloud.solutions/armbian/)  for the board you're setting up, and save it to your computer. We highly recommend using an HDMI connection if you've never set up a serial connection before, because additional drivers and software are required to get your development computer to communicate with the Lollipop via serial connection. Your "development computer" will be the laptop or desktop computer you use daily, or have borrowed for this purpose.
22
+You will need to [download Armbian](https://dl.lollipopcloud.solutions/armbian/)  for the board you're setting up, and save it to your computer. We highly recommend using an HDMI connection if you've never set up a serial connection before, because additional drivers and software are required to get your development computer to communicate with the Lollipop via serial connection. Your "development computer" will be the laptop or desktop computer you use daily, or have borrowed for this purpose.
23 23
 
24 24
 __NOTE:__ experienced users might want to use the experimental versions, but the rest of us should stick to the supported and stable builds.
25 25
 
26
-You will need to extract (unzip) the Armbian file once it downloads. Armbian is downloaded as a 7z archive (with the file extension .7z), so you may need a special program to extract this file. Try [Keka (link)](https://www.keka.io/) for MacOS, [7-zip (link)](http://www.7-zip.org/) for Windows, or 7z for Linux (`apt-get install p7zip-full`). Extract the file to a location you can remember (such as your desktop).
26
+You will need to extract (unzip) the Armbian file once it downloads. Armbian is downloaded as a 7z archive (with the file extension .7z), so you may need a special program to extract this file. Try [Keka](https://www.keka.io/) for MacOS, [7-zip](http://www.7-zip.org/) for Windows, or 7z for Linux (`apt-get install p7zip-full`). Extract the file to a location you can remember (such as your desktop).
27 27
 
28 28
 ### You will need to format your SD card as FAT32 before you can use it. Here's how:
29 29
 
@@ -32,19 +32,19 @@ To format an SD card on a Mac, open Terminal and use this command: `diskutil era
32 32
 
33 33
 #### For Windows users:
34 34
 
35
-Windows users will need some separate instructions. For now, try [Wikihow's article about formatting with Windows (link)](https://www.wikihow.com/Format-FAT32).
35
+Windows users will need some separate instructions. For now, try [Wikihow's article about formatting with Windows](https://www.wikihow.com/Format-FAT32).
36 36
 
37 37
 #### For Linux users:
38 38
 
39
-This can vary very slightly by distribution, but this article about [how to format an SD card in Linux (link)](https://www.cio.com/article/3176034/linux/how-to-format-an-sd-card-in-linux.html) should do the trick.
39
+This can vary very slightly by distribution, but this article about [how to format an SD card in Linux](https://www.cio.com/article/3176034/linux/how-to-format-an-sd-card-in-linux.html) should do the trick.
40 40
 
41 41
 #### For Android phone users with an SD card slot:
42 42
 
43
-This is a trick if you just don't want to be bothered with the previous options. Insert the SD card in your Android phone, then go to settings > storage > removable storage > format. Source: [SD card formatting (link).](https://raspberrypi.stackexchange.com/questions/1446/how-can-i-reformat-my-sd-card-to-use-it-normally-again#comment81498_1446)
43
+This is a trick if you just don't want to be bothered with the previous options. Insert the SD card in your Android phone, then go to settings > storage > removable storage > format. Source: [SD card formatting.](https://raspberrypi.stackexchange.com/questions/1446/how-can-i-reformat-my-sd-card-to-use-it-normally-again#comment81498_1446)
44 44
 
45 45
 #### Once you've formatted your SD card:
46 46
 
47
-If you don't already have one, you will also need an application/program to properly prepare your formatted SD card. [Etcher (link)](https://etcher.io/) works on most computers. To use Etcher: Insert the SD card into your computer (using an built-in reader or an external USB reader), load Etcher, select your newly extracted Armbian .img file, select the SD card you want to set up, and click Flash!
47
+If you don't already have one, you will also need an application/program to properly prepare your formatted SD card. [Etcher](https://etcher.io/) works on most computers. To use Etcher: Insert the SD card into your computer (using an built-in reader or an external USB reader), load Etcher, select your newly extracted Armbian .img file, select the SD card you want to set up, and click Flash!
48 48
 
49 49
 When Etcher is finished, you're ready to insert your Armbian SD card into your Orange Pi. Insert your HDMI cable or serial console, and keyboard or ethernet if you are using it, and then plug in the power cord. The Orange Pi should boot automatically.
50 50
 
@@ -54,7 +54,7 @@ If your board does not boot (the screen is blank or you cannot connect via SSH),
54 54
 
55 55
 Now you're reading to turn on your Lollipop device for the first time!
56 56
 
57
-If you're not using a keyboard, connect your Orange Pi (or the board you're using) with an ethernet cable to your local router and use your development computer to load Terminal (if using a Mac) and run `ssh root@192.168.1.x` (your board's IP address! make sure to use the root@IP_address format or else Terminal will tell the Orange Pi that you're trying to log in with your Mac's username) OR use [PuTTY (link)](https://putty.org/) to open an SSH connection to your Orange Pi. You may need to log into your router's settings to [find the IP address of your Orange Pi (link)](https://www.howtogeek.com/204057/how-to-see-who%E2%80%99s-connected-to-your-wi-fi-network/).
57
+If you're not using a keyboard, connect your Orange Pi (or the board you're using) with an ethernet cable to your local router and use your development computer to load Terminal (if using a Mac) and run `ssh root@192.168.1.x` (your board's IP address! make sure to use the root@IP_address format or else Terminal will tell the Orange Pi that you're trying to log in with your Mac's username) OR use [PuTTY](https://putty.org/) to open an SSH connection to your Orange Pi. You may need to log into your router's settings to [find the IP address of your Orange Pi](https://www.howtogeek.com/204057/how-to-see-who%E2%80%99s-connected-to-your-wi-fi-network/).
58 58
 
59 59
 Both keyboard and ethernet users will continue on the same path here:
60 60
 
@@ -62,17 +62,17 @@ Both keyboard and ethernet users will continue on the same path here:
62 62
 
63 63
 At first boot, you will be prompted to log in with the default login (root) and password (1234), and then prompted to change your root password. When you set your root password, make it a good one and don't forget it! Anyone with root access to your computer will have access to everything on that computer, including the ability to make malicious changes.
64 64
 
65
-Next, you will be prompted to create a new user account and password. This account will have [sudo (link)](https://en.wikipedia.org/wiki/Sudo) privileges, which is just as powerful (and dangerous) as root access, so you'll need another secure password. It is good practice to never login as root, so you'll be using this new user account for everything going forward.
65
+Next, you will be prompted to create a new user account and password. This account will have [sudo](https://en.wikipedia.org/wiki/Sudo) privileges, which is just as powerful (and dangerous) as root access, so you'll need another secure password. It is good practice to never login as root, so you'll be using this new user account for everything going forward.
66 66
 
67 67
 Once you've created an account, the desktop environment will load, and it's time to start setting things up!
68 68
 
69
-NOTE: If you are connected via SSH (running without a display or "headless"), you can also install [VNC Viewer (link)](https://www.realvnc.com/) on your development computer, and [set up VNC (Virtual Network Computing) on your Orange Pi (link)](https://forum.pine64.org/showthread.php?tid=794), so you can connect virtually without having to deal with a separate keyboard/monitor/etc setup. This is something you may use many times in the future, so it's worth taking the time to set it up, even if you're currently using a dedicated keyboard and display for your Lollipop. [More information about VNC. (link)](https://en.wikipedia.org/wiki/Virtual_Network_Computing)
69
+NOTE: If you are connected via SSH (running without a display or "headless"), you can also install [VNC Viewer](https://www.realvnc.com/) on your development computer, and [set up VNC (Virtual Network Computing) on your Orange Pi](https://forum.pine64.org/showthread.php?tid=794), so you can connect virtually without having to deal with a separate keyboard/monitor/etc setup. This is something you may use many times in the future, so it's worth taking the time to set it up, even if you're currently using a dedicated keyboard and display for your Lollipop. [More information about VNC.](https://en.wikipedia.org/wiki/Virtual_Network_Computing)
70 70
 
71 71
 ![The view with VNC Viewer](/screenshots/vnc-viewer.png)
72 72
 
73 73
 # Base Setup
74 74
 
75
-At this point, you might be ready to jump into the [Lollipop base setup code (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/base_setup.md). If you need a little more detail, continue following along here instead.
75
+At this point, you might be ready to jump into the [Lollipop base setup code](../armbian/base_setup.md). If you need a little more detail, continue following along here instead.
76 76
 
77 77
 If you are sticking with the command line via SSH, these steps will hopefully be straightforward. If you are using your new Lollipop with the desktop environment, you will have to open up a terminal window.
78 78
 
@@ -105,7 +105,7 @@ Now restart the service with `systemctl restart sshd`.
105 105
 
106 106
 # Congratulations! You've installed an entire operating system and completed the base setup! Time to customize your Lollipop!
107 107
 
108
-Now you're ready to head back to the [README (link)](../README.md) and get started on the networking section.
108
+Now you're ready to head back to the [README](../README.md) and get started on the networking section.
109 109
 
110 110
 **Closing suggestions:**
111 111
 

+ 16
- 16
for-beginners/how-to-gitea.md View File

@@ -1,14 +1,14 @@
1 1
 # Gitea cheat sheet for beginners and the forgetful
2 2
 Below is the basic Gitea workflow, to help you with your contributions. But do not hesitate to reach out to any of the organizers for help! We're happy to walk you through any or all of this, no matter what your experience level. If you've never even heard of Gitea before, we'd love to help you submit your first contribution!
3 3
 
4
-This document gets wordy because Git is not as welcoming to beginners as we wish it was, but you can do it! And you're not alone! We are just a message or comment away. There are even more resources in the [Bibliography](#Bibliography) at the end, if you want to dive deeper. You may even want to skip this document entirely at first, and see if [Your First Pull Request (link)](https://joshuahunter.com/posts/your-first-pull-request/) more suited to your needs.
4
+This document gets wordy because Git is not as welcoming to beginners as we wish it was, but you can do it! And you're not alone! We are just a message or comment away. There are even more resources in the [Bibliography](#Bibliography) at the end, if you want to dive deeper. You may even want to skip this document entirely at first, and see if [Your First Pull Request](https://joshuahunter.com/posts/your-first-pull-request/) more suited to your needs.
5 5
 
6
-If you need more Git, check out the [Git Book (link)](https://git-scm.com/book/en/v2).
6
+If you need more Git, check out the [Git Book](https://git-scm.com/book/en/v2).
7 7
 
8 8
 # Basic Steps For Contributing
9 9
 These are the general steps, but if you need more information, keep reading.
10 10
 
11
-* Fork the repository (just once) from [Lollipop Cloud project page (link)](https://git.lollipopcloud.solutions/)
11
+* Fork the repository (just once) from [Lollipop Cloud project page](https://git.lollipopcloud.solutions/)
12 12
 * Clone your fork on your own computer (just once)
13 13
 * Create a branch for your changes  
14 14
 * Edit, make changes and contributions
@@ -19,14 +19,14 @@ These are the general steps, but if you need more information, keep reading.
19 19
 # And now... what to do if you've never done this before
20 20
 
21 21
 ### Log in to Gitea
22
-If you haven't already, create an account on the [Lollipop Cloud project page (link)](https://git.lollipopcloud.solutions/) and log in.
22
+If you haven't already, create an account on the [Lollipop Cloud project page](https://git.lollipopcloud.solutions/) and log in.
23 23
 
24 24
 ### Fork it! (copy the project to your Gitea account)
25 25
 View the repository you would like to work on (docs or website), and click `Fork` in the upper right corner. You will only have to fork once!
26 26
 
27 27
 A fork is an exact copy of the project as it existed at the exact moment you forked it. So when the project updates in the future, you will have to update your code too, but we will talk about that later.
28 28
 
29
-At this point, you will need a command line client like [PuTTY (link)](https://putty.org/) for Windows users, or the built-in Terminal for MacOS users.
29
+At this point, you will need a command line client like [PuTTY](https://putty.org/) for Windows users, or the built-in Terminal for MacOS users.
30 30
 
31 31
 ### Go to (or create) a directory where you'd like your copy of the project to live, and open it.
32 32
 In PuTTY or Terminal, enter each of the following commands, where "lollipop_project" is the name of directory where you would like to store the clone.
@@ -68,7 +68,7 @@ The `git checkout` command at the end will create a branch, but this is a good p
68 68
 Now the changes you make will be associated with `new_branch_name`.
69 69
 
70 70
 ### Edit your contributions
71
-Now that the files live locally on your computer, and you have a branch set up for your new contributions, you can edit the files with your favorite editor. Stick with the command line (Vim, Emacs, Nano), or use a text editor like [Atom (link)](https://atom.io/). Be sure to save your changes.
71
+Now that the files live locally on your computer, and you have a branch set up for your new contributions, you can edit the files with your favorite editor. Stick with the command line (Vim, Emacs, Nano), or use a text editor like [Atom](https://atom.io/). Be sure to save your changes.
72 72
 
73 73
 ### Add your changed files to git, to prepare them for uploading
74 74
 If you added new files to the project, in your terminal you will have to `git add edited-file-name` for each of those new files.
@@ -106,13 +106,13 @@ Make your edits! Then you can go back to the section [about adding your changed
106 106
 
107 107
 # Bibliography
108 108
 
109
-* [Atom text editor (link)](https://atom.io/)
110
-* [Git Book (link)](https://git-scm.com/book/en/v2)
111
-* [Git Cheat Sheet (link)](https://github.com/mikeizbicki/ucr-cs100/blob/2015winter/textbook/cheatsheets/git-cheatsheet.md): May be helpful for setting up Git from scratch.
112
-* [Git Cheat Sheet - Advanced (link)](https://github.com/mikeizbicki/ucr-cs100/tree/2015winter/textbook/tools/git/advanced-git)
113
-* [Git Game (link)](https://www.git-game.com/): get serious about Git by gameifying your learning.
114
-* [Oh shit, git! (link)](http://ohshitgit.com/): how to fix a few Git mistakes (we all make them!)
115
-* [PuTTY SSH and telnet client (link)](https://putty.org/)
116
-* [Syncing a fork (link)](https://help.github.com/articles/syncing-a-fork/)
117
-* [Vim Cheat Sheet (link)](http://vimsheet.com/)
118
-* [Your First Pull Request (link)](https://joshuahunter.com/posts/your-first-pull-request/)
109
+* [Atom text editor](https://atom.io/)
110
+* [Git Book](https://git-scm.com/book/en/v2)
111
+* [Git Cheat Sheet](https://github.com/mikeizbicki/ucr-cs100/blob/2015winter/textbook/cheatsheets/git-cheatsheet.md): May be helpful for setting up Git from scratch.
112
+* [Git Cheat Sheet - Advanced](https://github.com/mikeizbicki/ucr-cs100/tree/2015winter/textbook/tools/git/advanced-git)
113
+* [Git Game](https://www.git-game.com/): get serious about Git by gameifying your learning.
114
+* [Oh shit, git!](http://ohshitgit.com/): how to fix a few Git mistakes (we all make them!)
115
+* [PuTTY SSH and telnet client](https://putty.org/)
116
+* [Syncing a fork](https://help.github.com/articles/syncing-a-fork/)
117
+* [Vim Cheat Sheet](http://vimsheet.com/)
118
+* [Your First Pull Request](https://joshuahunter.com/posts/your-first-pull-request/)

Loading…
Cancel
Save