Merge pull request #10 from renuo/feature/lint-md

.github/workflows/linting.yml

@@ -16,5 +16,3 @@ jobs:
       - uses: actions/checkout@v2
       - name: Run mdl
         uses: actionshub/markdownlint@main
-        with:
-          filesToIgnoreRegex: "SUMMARY.md"

README.md

@@ -0,0 +1,12 @@
+# Laptop Setup Guide for macOS
+
+This page is created with VitePress and hosted on Cloudflare Pages.
+
+- <https://laptop-setup-guide.renuo.ch>
+
+## Development
+
+```bash
+bin/setup
+bin/run
+```

non-technical-setup.md

@@ -7,7 +7,6 @@ outline: deep
 This is the part of the setup guide where you will install the minimum software and programs to get started at Renuo.
 If you are experienced you can choose your own setup, but we recommend that you follow our setup instructions.
 
-
 ## macOS Setup
 
 Now we're going to set up your freshly unboxed Macbook. Below we list some important/useful settings, you should consider applying
@@ -49,7 +48,6 @@ _More infos about how to increase your mac security can be found here:_
 [Apple Support](https://support.apple.com/guide/mac-help/set-up-your-mac-to-be-secure-flvlt003/mac)
 - For even much more information, visit this guide [macOS-Security-and-Privacy-Guide](https://github.com/drduh/macOS-Security-and-Privacy-Guide)
 
-
 ## Software Updates & Programs
 
 ### Google Chrome
@@ -136,12 +134,9 @@ To start your session for the setup just input your ticket number or subscriptio
 
 By the way, [Redmine Tracky is open source](https://github.com/renuo/redmine_tracky/). PRs are always welcome 😁.
 
-
 ## Congratulations 🥳
 
 You are now ready to start working with the Renuo stack. You can now continue with the technical setup.
 
 If you are not going to do the technical setup, please have a look at the [Nice to have](/nice_to_have/index.md) section.
 There might be something interesting for you.
-
-

technical-setup.md

@@ -27,7 +27,6 @@ Please don’t skip parts of this guide and don’t start with the next part or
 - **Discuss changes:** Please extend or correct this guide if you think the information is missing, wrong or outdated. Discuss the changes you want to make here with at least one other person before you make them.
 - **Ask for help:** If you have any questions, please ask for help. We are happy to help you.
 
-
 ## Apple Developer and Xcode
 
 ### Apple Developer
@@ -49,12 +48,10 @@ Xcode is necessary for all the following steps.
 
 While Xcode is installing, you can take a break and get a coffee ☕️.
 
-
 ## iTerm2 - Better macOS Terminal
 
 We recommend you to use [iTerm2](https://iterm2.com/iTerm2) - macOS Terminal Replacement but you can freely choose your desired terminal application.
 
-
 ## Homebrew
 
 ::: danger Warning
@@ -66,7 +63,6 @@ Homebrew is a very convenient package manager for Mac. Go to [Brew](https://brew
 - ``` brew update ```
 - ``` brew upgrade ```
 
-
 ## Console Editor
 
 ### Vim
@@ -106,7 +102,6 @@ code .gitconfig
 vim .gitconfig
 ```
 
-
 ## ZSH
 
 This is an alternative shell to bash (Mac standard).
@@ -138,7 +133,6 @@ For zsh there are several plugin systems. One of them is antigen. It's very flex
 - ```antigen theme agnoster```
 - ```antigen apply```
 
-
 ## git
 
 This is a distributed versioning control system widely used. It's our standard.
@@ -197,21 +191,18 @@ Thumbs.db
 .Trashes
 ```
 
-
 ## Git Flow
 
 [Git Flow](https://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/) is a branching convention we use at Renuo. There is a tool which makes it more convenient to use:
 
 - `brew install git-flow`
 
-
 ## GPG
 
 This is a tool for public key crypto. There is also a tool called GPGSuite which has a GUI. You can use gpg to create your ssh key.
 
 - ```brew install gpg```
 
-
 ## Setup SSH Key
 
 An SSH key is a token which can be used to identify you and your machine. Everyone at our company has at least one. You can use this guide to create one:
@@ -270,22 +261,19 @@ To support .ruby-version add this to your `~/.asdfrc`
 
 See also [Guide](https://asdf-vm.com/guide/getting-started.html#using-existing-tool-version-files)
 
-
 ## yarn
 
 Yarn is a package manager for node packages.
 
 - ```brew install yarn --ignore-dependencies```
 
-
 ## postgresql
 
 Postgres is the main database we use for our projects. Install it and configure it to be started automatically:
 
 - ```brew install postgresql```
 - ```brew services start postgresql```
 
-
 ## Redis
 
 Redis is used for ActionCable in Rails 5.2 and other projects with Sidekiq. You can use homebrew to install it:
@@ -296,14 +284,12 @@ After the installation run through, you will get a command to start redis:
 
 - ``` brew services restart redis ```
 
-
 ## Heroku CLI
 
 To add the Heroku CLI, please use the following command.
 
 - ```brew tap heroku/brew && brew install heroku```
 
-
 ## Renuo CLI
 
 To add the Renuo CLI, please use the following command.
@@ -312,7 +298,6 @@ To add the Renuo CLI, please use the following command.
 - `asdf global ruby latest`
 - `gem install renuo-cli`
 
-
 ## Important Homebrew Apps
 
 ### Shared MIME Info
@@ -331,7 +316,6 @@ See [Guide](https://github.com/mimemagicrb/mimemagic)
 
 - ``` brew install pdftk-java ```
 
-
 ## Congratulations 🥳
 
 You are now ready to start working with the Renuo stack.