Skip to content

Commit

Permalink
Links between pages should not start with /, this messes up nav
Browse files Browse the repository at this point in the history
github pages doesn't add the `/geogeeks/` to the URL

the correct way is link to the *.md file, relative to the folder you're in
  • Loading branch information
hugoledoux committed Oct 6, 2023
1 parent c30a297 commit 6e07aba
Show file tree
Hide file tree
Showing 9 changed files with 22 additions and 22 deletions.
2 changes: 1 addition & 1 deletion docs/computer/filesystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Developing software means that you'll interact with the file system of your comp
</div>
This explains the basics: what is a file, an extension, a folder, etc.
It is of the utmost importance to fully understand this!
Also, since you'll be during the MSc working with Linux, you should also understand how [its file system works](/computer/terminal/) (it is the same as macOS but rather different from Windows).
Also, since you'll be during the MSc working with Linux, you should also understand how [its file system works](terminal.md) (it is the same as macOS but rather different from Windows).

!!! video "Understanding the file system. Part 2. <span class="tag beginner-tag">⭐️ Beginner</span>"
<div style="display: flex; justify-content: center; padding-bottom: 1em;">
Expand Down
8 changes: 4 additions & 4 deletions docs/computer/packagemanager.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Different operating systems have different package managers.
3. The command to install this package
4. A copy button for the installation command

Simply copy this command, and run it in your Powershell [terminal](/computer/terminal)
Simply copy this command, and run it in your Powershell [terminal](terminal.md)

!!! tip "More commands"
Chocolatey has more commands, for things like updating and uninstalling. For these, please see the [official documentation](https://docs.chocolatey.org/en-us/choco/commands/) (specifically `info`, `uninstall`, and `upgrade`).
Expand All @@ -83,7 +83,7 @@ Different operating systems have different package managers.

For MacOS, we recommend the [Homebrew package manager](https://brew.sh). It's free and open source.

**To install Homebrew, simply run this command in your [terminal](/computer/terminal) and follow the instructions.**
**To install Homebrew, simply run this command in your [terminal](terminal.md) and follow the instructions.**

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
Expand Down Expand Up @@ -129,14 +129,14 @@ Different operating systems have different package managers.
3. Copy button for the installation command
4. Version of the package you're installing.

Simply copy this command, and run it in your [terminal](/computer/terminal)
Simply copy this command, and run it in your [terminal](terminal.md)

!!! tip "More commands"
Homebrew has more commands, for things like updating and uninstalling. For these, please see the [official documentation](https://docs.brew.sh/Manpage) (specifically `info`, `uninstall`, and `upgrade`).

=== ":simple-linux: Linux"

This tab is geared towards Geomatics students using Ubuntu (under [Windows Subsystem for Linux](/computer/wsl)). If you're using another distro, we recommend finding a package management guide specific to that distro.
This tab is geared towards Geomatics students using Ubuntu (under [Windows Subsystem for Linux](wsl.md)). If you're using another distro, we recommend finding a package management guide specific to that distro.

Ubuntu comes installed with the `apt` package manager. It has a huge collection of available packages.

Expand Down
8 changes: 4 additions & 4 deletions docs/computer/perfectsetup.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,22 @@
- **C++**: [CLion](https://www.jetbrains.com/clion/) as IDE; [Homebrew](https://brew.sh/) as package manager; CMake as builder
- **GIS**: [QGIS](https://www.qgis.org/en/site/forusers/download.html)
- **3D data**: [MeshLab](https://www.meshlab.net/) as viewer/editor of 2-manifold meshes; [CloudCompare](https://www.cloudcompare.org/) for point clouds; [ParaView](https://www.paraview.org/) for volumetric meshes
- **LaTeX**: [MacTeX](https://www.tug.org/mactex/mactex-download.html) as compiler; your [favourite text editor](/computer/bestsoftware/) as IDE; BibDesk for BibTeX management (both bundled with MacTeX)
- **LaTeX**: [MacTeX](https://www.tug.org/mactex/mactex-download.html) as compiler; your [favourite text editor](bestsoftware.md) as IDE; BibDesk for BibTeX management (both bundled with MacTeX)

=== ":simple-linux: Linux"
- [APT](https://en.wikipedia.org/wiki/APT_(software)) for package manager for pretty much everything (we assume you use a Debian-based version like Ubuntu)
- **Python**: [PyCharm](https://www.jetbrains.com/pycharm-edu/) as IDE; pypi as package manager; [pyenv](https://github.com/pyenv/pyenv) as environment manager
- **C++**: CLion](https://www.jetbrains.com/clion/) as IDE; Advanced Packaging Tool ( `apt`) as package manager; CMake as builder
- **GIS**: [QGIS](https://www.qgis.org/en/site/forusers/download.html)
- **3D data**: [MeshLab](https://www.meshlab.net/) as viewer/editor of 2-manifold meshes; [CloudCompare](https://www.cloudcompare.org/) for point clouds; [ParaView](https://www.paraview.org/) for volumetric meshes
- **LaTeX**: `apt install texlive` as compiler; your [favourite text editor](/computer/bestsoftware/) as IDE; [JabRef](https://www.jabref.org/) for BibTeX management
- **LaTeX**: `apt install texlive` as compiler; your [favourite text editor](bestsoftware.md) as IDE; [JabRef](https://www.jabref.org/) for BibTeX management

=== ":simple-windows: Windows"
- [WSL](/computer/wsl/) is really important to be able to run Linux
- [WSL](wsl.md) is really important to be able to run Linux
- **Python**: [PyCharm](https://www.jetbrains.com/pycharm-edu/) as IDE; pypi as package manager; [pyenv](https://github.com/pyenv/pyenv) as environment manager
- **C++**: CLion](https://www.jetbrains.com/clion/) as IDE; brew as package manager; CMake as builder
- **GIS**: [QGIS](https://www.qgis.org/en/site/forusers/download.html)
- **3D data**: [MeshLab](https://www.meshlab.net/) as viewer/editor of 2-manifold meshes; [CloudCompare](https://www.cloudcompare.org/) for point clouds; [ParaView](https://www.paraview.org/) for volumetric meshes
- **LaTeX**: [MikTeX](https://miktex.org/) as compiler; your [favourite text editor](/computer/bestsoftware/) as IDE; [JabRef](https://www.jabref.org/) for BibTeX management
- **LaTeX**: [MikTeX](https://miktex.org/) as compiler; your [favourite text editor](bestsoftware.md) as IDE; [JabRef](https://www.jabref.org/) for BibTeX management

TODO
2 changes: 1 addition & 1 deletion docs/computer/terminal.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ It's often a quicker and more precise way to interact with the computer, and it

!!! note
Observe that the commands for the PowerShell and those of macOS/Linux will differ slightly.
For Windows, you can always install [WSL](/computer/wsl/) and use the Linux Terminal.
For Windows, you can always install [WSL](wsl.md) and use the Linux Terminal.


## Basic (bash) commands
Expand Down
2 changes: 1 addition & 1 deletion docs/git/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To use it, you'll need to [create a (free) GitHub account](https://docs.github.c

## Git in the terminal

If you use Linux, or if you want to use the [terminal](/computer/terminal/), you can install Git this way:
If you use Linux, or if you want to use the [terminal](../computer/terminal.md), you can install Git this way:

=== ":simple-apple: macOS"
In the console: `xcode-select --install` will install clang, gcc, and git.
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@

1. Click on the 'Edit this page'
2. You have to login to GitHub
3. Modify the Markdown text following our [style guide](/contribute/)
3. Modify the Markdown text following our [style guide](contribute/index.md)
4. Create a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)


## Style guide for icons and tabs

[Style guide](/contribute/)
[Style guide](contribute/index.md)
8 changes: 4 additions & 4 deletions docs/python/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Python is a programming language that's easy to read, write, and understand. It's used a lot in Geomatics because:

- **Quick to write:** When making scripts for data analysis, most of the time you care a lot about how fast you can *write* the code and not too much about how fast the code will *run*. Python is very quick to *write*.
- **Many libraries:** There are many so-called "libraries" made for Python and they're easy to install. These libraries contain code other people wrote, so you don't have to code everything yourself. For example, if you want to open a shapefile, someone made a library for that! See [our list of useful libraries for Geomatics](/python/pypackages).
- **Many libraries:** There are many so-called "libraries" made for Python and they're easy to install. These libraries contain code other people wrote, so you don't have to code everything yourself. For example, if you want to open a shapefile, someone made a library for that! See [our list of useful libraries for Geomatics](pypackages.md).
- **Open source, free, very popular:** Python is free for anyone to use, and its code is open source. There is lots of help out there on the internet, as it's one of the most popular programming languages worldwide. It's an industry standard in many Geomatics companies.

### Installing Python
Expand All @@ -16,16 +16,16 @@ For Python code to run, you need a program called "the Python interpreter" (or m

So what to do instead? We recommend installing and managing Python using "pyenv". Pyenv is a tool that allows you to *install* multiple versions of Python, and *select* which specific version is *active*.

[This guide shows you how to install Python using pyenv.](/python/install)
[This guide shows you how to install Python using pyenv.](install.md)

### Python FAQ
!!! question "When should I use Python for my project? (Over something like C++)"
Short answer: If you want to write code quickly, use lots of libraries, and speed isn't crucial.

Long answer: See [How to choose a programming language](/programming/chooselanguage).
Long answer: See [How to choose a programming language](../programming/chooselanguage.md).

### Learning Python
%% TODO

### Other useful Python Resources
- We've made a list of a bunch of [useful Python packages for Geomatics](/python/pypackages)
- We've made a list of a bunch of [useful Python packages for Geomatics](pypackages.md)
8 changes: 4 additions & 4 deletions docs/python/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
We recommend installing and managing Python using "pyenv". Pyenv is a tool that allows you to *install* multiple versions of Python, and *select* which specific version is *active*.

=== ":simple-apple: macOS"
To install Python via pyenv, make sure you have [Homebrew](/computer/packagemanager) installed and then run the following commands in your [terminal](/computer/terminal).
To install Python via pyenv, make sure you have [Homebrew](../computer/packagemanager.md) installed and then run the following commands in your [terminal](../computer/terminal.md).

**Step 1: Install pyenv using Homebrew**
```bash
Expand All @@ -26,7 +26,7 @@ We recommend installing and managing Python using "pyenv". Pyenv is a tool that


=== ":simple-linux: Linux"
Run the following commands in your [terminal](/computer/terminal).
Run the following commands in your [terminal](../computer/terminal.md).

**Step 1: Install pyenv**
```bash
Expand All @@ -36,14 +36,14 @@ We recommend installing and managing Python using "pyenv". Pyenv is a tool that
=== ":simple-windows: Windows"
Note: pyenv was created for MacOS and Linux, the version for Windows is called "pyenv-win". However, it works the same as pyenv and the command in the terminal is still `pyenv`.

To install Python via pyenv-win, make sure you have [Chocolatey](/computer/packagemanager) installed and then run the following commands in your [Powershell terminal](/computer/terminal).
To install Python via pyenv-win, make sure you have [Chocolatey](../computer/packagemanager.md) installed and then run the following commands in your [Powershell terminal](../computer/terminal.md).

**Step 1: Install pyenv-win using Chocolatey**
```powershell
choco install pyenv-win
```

Restart your terminal after running this command. Are you getting an error when using pyenv in the following steps? Make sure you followed all instructions in the [Chocolatey installation guide](/computer/packagemanager).
Restart your terminal after running this command. Are you getting an error when using pyenv in the following steps? Make sure you followed all instructions in the [Chocolatey installation guide](../computer/packagemanager.md).

!!! warning "Important, disable Python Microsoft Store link"
On Windows, by default the command `python` will open the Microsoft Store for you to download Python. Disable this with these steps:
Expand Down
2 changes: 1 addition & 1 deletion docs/python/pypackages.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Useful Python packages for geomatics

!!! info "How to install Python packages"
Please see our [Install Python packages using pip guide](/python.pip).
Please see our [Install Python packages using pip guide](pip.md).

- [cjio](https://github.com/cityjson/cjio): Python CLI + API to process and manipulate [CityJSON](https://www.cityjson.org/) files
- [Fiona](https://github.com/Toblerity/Fiona): to read/write GIS data, the "Pythonic GDAL"
Expand Down

0 comments on commit 6e07aba

Please sign in to comment.