Skip to content

Commit 08c59af

Browse files
authored
Merge pull request #123 from IDI-Systems/fixLink
Fix development section cross-reference links
2 parents 371bf06 + 28c19c4 commit 08c59af

File tree

7 files changed

+27
-13
lines changed

7 files changed

+27
-13
lines changed

docs/_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ company_name: IDI-Systems
1010
github_editme_path: IDI-Systems/acre2/blob/master/docs
1111
feedback_disable: true
1212

13-
exclude: [.idea/, pdfconfigs, .editorconfig, .gitignore, CNAME, Gemfile, Gemfile.lock, "*.sh", README.md]
13+
exclude: [.idea/, pdfconfigs, .editorconfig, .gitignore, CNAME, docker-compose.yml, Dockerfile, Gemfile, Gemfile.lock, "*.sh", README.md]
1414

1515
gems:
1616
- jekyll-redirect-from

docs/_config_dev.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ company_name: IDI-Systems
1010
github_editme_path: IDI-Systems/acre2/blob/master/docs
1111
feedback_disable: true
1212

13-
exclude: [.idea/, pdfconfigs, .editorconfig, .gitignore, CNAME, Gemfile, Gemfile.lock, "*.sh", README.md]
13+
exclude: [.idea/, pdfconfigs, .editorconfig, .gitignore, CNAME, docker-compose.yml, Dockerfile, Gemfile, Gemfile.lock, "*.sh", README.md]
1414

1515
gems:
1616
- jekyll-redirect-from

docs/_data/sidebar.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ entries:
151151
output: web, pdf
152152

153153
- title: Building Extensions
154-
url: /wiki/development/building-extensions.
154+
url: /wiki/development/building-extensions
155155
output: web, pdf
156156

157157
- title: Coding Guidelines (SQF)

docs/wiki/development/building-extensions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This page describes how you can setup your extensions development environment fo
1212

1313
## Build Project (Windows)
1414

15-
_This is done automatically when doing a [release build](./Building-ACRE2#create-a-release-build) with `compile` option._
15+
_This is done automatically when doing a [release build](building#create-a-release-build) with `compile` option._
1616

1717
- Open a command prompt and navigate to the folder in which you downloaded or Git cloned out the ACRE2 source.
1818

@@ -30,4 +30,4 @@ _Only `ACRE2TS` project (`acre2_win64.dll`) TeamSpeak plugin can be built in 64-
3030
- Navigate to the `extensions\vcproj64` directory.
3131
- Run `cmake .. -DUSE_64BIT_BUILD=ON -G "Visual Studio 14 2015 Win64"` (replace generator for any other 64-bit Visual Studio generator)
3232

33-
Extensions files will also be copied to their appropriate locations automatically after compilation (ready for [test](./Building-ACRE2#create-a-test-build) and [release](./Building-ACRE2#create-a-release-build) builds).
33+
Extensions files will also be copied to their appropriate locations automatically after compilation (ready for [test](building#create-a-test-build) and [release](building#create-a-release-build) builds).

docs/wiki/development/building.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,13 @@ To start the game using this build, you can use the following modline:
6161
-mod=@CBA_A3;idi\clients\acre
6262
```
6363

64-
You will also need `acre.dll` and `ACRE2Arma.dll` placed in `idi\clients\acre` folder. You can obtain those from last release or [build them yourself](../Building-ACRE2-Extensions). TeamSpeak plugin is not required for basic operation.
64+
You will also need `acre.dll` and `ACRE2Arma.dll` placed in `idi\clients\acre` folder. You can obtain those from last release or [build them yourself](building-extensions). TeamSpeak plugin is not required for basic operation.
6565

6666
### Create a Release Build
6767

6868
To create a complete build of ACRE2 that you can use without the source files you will need:
6969

70-
- All [C++ requirements](./Building-ACRE2-Extensions#requirements)
70+
- All [C++ requirements](building-extensions)
7171
- `msbuild` in `PATH` environment variable (usually `C:\Program Files (x86)\MSBuild\14.0\Bin`)
7272
- Ensure `.hpp` is **NOT** in pboProject's "Exclude From Pbo" list
7373

docs/wiki/development/docs_installation.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,65 +32,79 @@ We include files for [Docker](https://www.docker.com/) to run Jekyll in a separa
3232
- Install [Ruby DevKit for 2.0 and above (x64)](http://rubyinstaller.org/downloads/)
3333
- Install [NodeJS](https://nodejs.org/download/)
3434
- Open Command Prompt and navigate to this directory
35+
3536
```
3637
cd <ACRE2_directory>/docs
3738
```
3839
3940
- Install `bundler` and `jekyll` gems
41+
4042
```
4143
gem install bundler jekyll
4244
```
4345
4446
- Install required gems through `bundler`
47+
4548
```
4649
bundle install
4750
```
4851
4952
#### Debian / Bash on Ubuntu on Windows
5053
54+
_`sudo` might be required when using below commands._
55+
5156
- Open Bash and navigate to this directory
57+
5258
```
5359
cd <ACRE2_directory>/docs
5460
```
5561
5662
- Install `make`, `gcc` and `nodejs`
63+
5764
```
58-
sudo apt-get install make gcc nodejs
65+
apt-get install make gcc nodejs
5966
```
6067
6168
- Install `ruby2.3`, `rbuy2.3-dev` and `ruby-switch`
69+
6270
```
63-
sudo apt-add-repository ppa:brightbox/ruby-ng
64-
sudo apt-get update
65-
sudo apt-get install ruby2.3 ruby2.3-dev ruby-switch
71+
apt-add-repository ppa:brightbox/ruby-ng
72+
apt-get update
73+
apt-get install ruby2.3 ruby2.3-dev ruby-switch
6674
```
6775
6876
- Set Ruby version
77+
6978
```
70-
sudo ruby-switch --set ruby2.3
79+
ruby-switch --set ruby2.3
7180
```
7281
7382
- Install `bundler` and `jekyll`
83+
7484
```
75-
sudo gem install bundler jekyll
85+
gem install bundler jekyll
7686
```
7787
7888
- Install required gems through bundler
89+
7990
```
8091
bundle install
8192
```
8293
8394
- In case of sticky folder error during `bundle install`, execute the following to fix permissions
95+
8496
```
8597
find ~/.bundle/cache -type d -exec chmod 0755 {} +
8698
```
8799
88100
#### Running
89101
90102
- Run Jekyll through bundler
103+
91104
```
92105
bundle exec jekyll serve --future --incremental --config _config_dev.yml
93106
```
107+
94108
_Use `--force_polling` on Bash on Ubuntu on Windows due to a bug preventing watching._
95109
96110
- Navigate to http://localhost:4000

0 commit comments

Comments
 (0)