Skip to content

Commit 1fc5105

Browse files
committed
docs: autogenerate heading link anchors
Remove custom anchor links and generate them automatically using the toc markdown extension. Links updated to match new anchors. This fixes the custom links coloring the heading blue, which isn't the best if user selects the dark theme. Heading changes done by: cd docs && sed -i -r 's/(#*).*> (.*?) <\/a>/\1 \2/g' *md */*md */*/*md
1 parent 6be71a5 commit 1fc5105

18 files changed

+323
-321
lines changed

docs/Basic_setup/Accessing-your-Device-from-the-internet.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ From time to time the IP address that your ISP assigns changes and it's difficul
66

77
Secondly, how do you get into your home network? Your router has a firewall that is designed to keep the rest of the internet out of your network to protect you. The solution to that is a Virtual Private Network (VPN) or "tunnel".
88

9-
## <a name="dynamicDNS"> Dynamic DNS </a>
9+
## Dynamic DNS
1010

1111
There are two parts to a Dynamic DNS service:
1212

1313
1. You have to register with a Dynamic DNS service provider and obtain a domain name that is not already taken by someone else.
1414
2. Something on your side of the network needs to propagate updates so that your chosen domain name remains in sync with your router's dynamically-allocated public IP address.
1515

16-
### <a name="registerDDNS"> Register with a Dynamic DNS service provider </a>
16+
### Register with a Dynamic DNS service provider
1717

1818
The first part is fairly simple and there are quite a few Dynamic DNS service providers including:
1919

@@ -24,7 +24,7 @@ The first part is fairly simple and there are quite a few Dynamic DNS service pr
2424
2525
Some router vendors also provide their own built-in Dynamic DNS capabilities for registered customers so it's a good idea to check your router's capabilities before you plough ahead.
2626

27-
### <a name="propagateDDNS"> Dynamic DNS propagation </a>
27+
### Dynamic DNS propagation
2828

2929
The "something" on your side of the network propagating WAN IP address changes can be either:
3030

@@ -39,7 +39,7 @@ A behind-the-router technique usually relies on sending updates according to a s
3939

4040
> This seems to be a problem for DuckDNS which takes a beating because almost every person using it is sending an update bang-on five minutes.
4141
42-
### <a name="duckDNSclient"> DuckDNS client </a>
42+
### DuckDNS client
4343

4444
IOTstack provides a solution for DuckDNS. The best approach to running it is:
4545

@@ -99,7 +99,7 @@ A null result indicates failure so check your work.
9999

100100
Remember, the Domain Name System is a *distributed* database. It takes *time* for changes to propagate. The response you get from directing a query to ns1.duckdns.org may not be the same as the response you get from any other DNS server. You often have to wait until cached records expire and a recursive query reaches the authoritative DuckDNS name-servers.
101101

102-
#### <a name="duckDNSauto"> Running the DuckDNS client automatically </a>
102+
#### Running the DuckDNS client automatically
103103

104104
The recommended arrangement for keeping your Dynamic DNS service up-to-date is to invoke `duck.sh` from `cron` at five minute intervals.
105105

docs/Basic_setup/Updates/gcgarner-migration.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Migrating to SensorsIot/IOTstack was fairly easy when this repository was first
66

77
The probability of conflicts developing increases as a function of time since the fork. Conflicts were and are pretty much inevitable so a more involved procedure is needed.
88

9-
## <a name="migrationSteps"> Migration Steps </a>
9+
## Migration Steps
1010

11-
### <a name="checkAssumptions"> Step 1 – Check your assumptions </a>
11+
### Step 1 – Check your assumptions
1212

1313
Make sure that you are, *actually*, on gcgarner. Don't assume!
1414

@@ -20,7 +20,7 @@ origin https://github.com/gcgarner/IOTstack.git (push)
2020

2121
Do not proceed if you don't see those URLs!
2222

23-
### <a name="downStack"> Step 2 – Take IOTstack down </a>
23+
### Step 2 – Take IOTstack down
2424

2525
Take your stack down. This is not *strictly* necessary but we'll be moving the goalposts a bit so it's better to be on the safe side.
2626

@@ -29,22 +29,22 @@ $ cd ~/IOTstack
2929
$ docker-compose down
3030
```
3131

32-
### <a name="chooseMigrationMethod"> Step 3 – Choose your migration method </a>
32+
### Step 3 – Choose your migration method
3333

3434
There are two basic approaches to switching from gcgarner/IOTstack to SensorsIot/IOTstack:
3535

36-
- [Migration by changing upstream repository](#migrateChangeUpstream)
37-
- [Migration by clone and merge](#migrateCloneMerge)
36+
- [Migration by changing upstream repository](#migration-option-1-change-upstream-repository)
37+
- [Migration by clone and merge](#migration-option-2-clone-and-merge)
3838

3939
You can think of the first as "working *with* git" while the second is "using brute force".
4040

4141
The first approach will work if you haven't tried any other migration steps and/or have not made too many changes to items in your gcgarner/IOTstack that are under git control.
4242

43-
If you are already stuck or you try the first approach and get a mess, or it all looks far too hard to sort out, then try the [Migration by clone and merge](#migrateCloneMerge) approach.
43+
If you are already stuck or you try the first approach and get a mess, or it all looks far too hard to sort out, then try the [Migration by clone and merge](#migration-option-2-clone-and-merge) approach.
4444

45-
#### <a name="migrateChangeUpstream"> Migration Option 1 – change upstream repository </a>
45+
#### Migration Option 1 – change upstream repository
4646

47-
##### <a name="checkLocalChanges"> Check for local changes </a>
47+
##### Check for local changes
4848

4949
Make sure you are on the master branch (you probably are so this is just a precaution), and then see if Git thinks you have made any local changes:
5050

@@ -93,15 +93,15 @@ The simplest way to deal with modified files is to rename them to move them out
9393
menu.sh.jqh
9494
```
9595

96-
##### <a name="synchroniseGcgarner"> Synchronise with gcgarner on GitHub </a>
96+
##### Synchronise with gcgarner on GitHub
9797

9898
Make sure your local copy of gcgarner is in sync with GitHub.
9999

100100
```
101101
$ git pull
102102
```
103103

104-
##### <a name="removeUpstream"> Get rid of any upstream reference </a>
104+
##### Get rid of any upstream reference
105105

106106
There may or may not be any "upstream" set. The most likely reason for this to happen is if you used your local copy as the basis of a Pull Request.
107107

@@ -111,15 +111,15 @@ The next command will probably return an error, which you should ignore. It's ju
111111
$ git remote remove upstream
112112
```
113113

114-
##### <a name="pointToSensorsIoT"> Point to SensorsIot </a>
114+
##### Point to SensorsIot
115115

116116
Change your local repository to point to SensorsIot.
117117

118118
```
119119
$ git remote set-url origin https://github.com/SensorsIot/IOTstack.git
120120
```
121121

122-
##### <a name="syncSensorsIoT"> Synchronise with SensorsIot on GitHub </a>
122+
##### Synchronise with SensorsIot on GitHub
123123

124124
This is where things can get a bit tricky so please read these instructions carefully **before** you proceed.
125125

@@ -174,19 +174,19 @@ Auto-merging .templates/someRandomService/service.yml
174174

175175
If you don't use `someRandomService` then you could safely ignore this on the basis that it was "probably right". However, if you did use that service and it started to misbehave after migration, you would know that the `service.yml` file was a good place to start looking for explanations.
176176

177-
##### <a name="finishWithPull"> Finish with a pull </a>
177+
##### Finish with a pull
178178

179179
At this point, only the migrated master branch is present on your local copy of the repository. The next command brings you fully in-sync with GitHub:
180180

181181
```
182182
$ git pull
183183
```
184184

185-
#### <a name="migrateCloneMerge"> Migration Option 2 – clone and merge </a>
185+
#### Migration Option 2 – clone and merge
186186

187187
If you have been following the process correctly, your IOTstack will already be down.
188188

189-
##### <a name="renameOldIOTstack"> Rename your existing IOTstack folder </a>
189+
##### Rename your existing IOTstack folder
190190

191191
Move your old IOTstack folder out of the way, like this:
192192

@@ -199,7 +199,7 @@ Note:
199199

200200
* You should not need `sudo` for the `mv` command but it is OK to use it if necessary.
201201

202-
##### <a name="fetchCleanClone"> Fetch a clean clone of SensorsIot/IOTstack </a>
202+
##### Fetch a clean clone of SensorsIot/IOTstack
203203

204204
```
205205
$ git clone https://github.com/SensorsIot/IOTstack.git ~/IOTstack
@@ -240,7 +240,7 @@ Observe what is **not** there:
240240

241241
From this, it should be self-evident that a clean checkout from GitHub is the factory for *all* IOTstack installations, while the contents of `backups`, `services`, `volumes` and `docker-compose.yml` represent each user's individual choices, configuration options and data.
242242

243-
##### <a name="mergeOldWithNew"> Merge old into new </a>
243+
##### Merge old into new
244244

245245
Execute the following commands:
246246

@@ -272,7 +272,7 @@ There is no need to migrate the `backups` directory. You are better off creating
272272
$ mkdir ~/IOTstack/backups
273273
```
274274

275-
### <a name="chooseMenu"> Step 4 – Choose your menu </a>
275+
### Step 4 – Choose your menu
276276

277277
If you have reached this point, you have migrated to SensorsIot/IOTstack where you are on the "master" branch. This implies "new menu".
278278

@@ -353,15 +353,15 @@ Although you can freely change branches, it's probably not a good idea to try to
353353

354354
Even so, nothing will change **until** you run your chosen menu to completion and allow it to generate a new `docker-compose.yml`.
355355

356-
### <a name="upStack"> Step 5 – Bring up your stack </a>
356+
### Step 5 – Bring up your stack
357357

358358
Unless you have gotten ahead of yourself and have already run the menu (old or new) then nothing will have changed in the parts of your `~/IOTstack` folder that define your IOTstack implementation. You can safely:
359359

360360
```
361361
$ docker-compose up -d
362362
```
363363

364-
## <a name="seeAlso"> See also </a>
364+
## See also
365365

366366
There is another gist [Installing Docker for IOTstack](https://gist.github.com/Paraphraser/d119ae81f9e60a94e1209986d8c9e42f) which explains how to overcome problems with outdated Docker and Docker-Compose installations.
367367

0 commit comments

Comments
 (0)