Skip to content

Commit

Permalink
fix syntax of hints, warning, tips
Browse files Browse the repository at this point in the history
  • Loading branch information
hanjoosten committed Oct 15, 2023
1 parent e65432f commit 57aa5a5
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 13 deletions.
6 changes: 4 additions & 2 deletions docs/the-tools-we-use/automation-of-releasing-ci-cd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,11 @@ The release of Ampersand is largely automated because we want:

First of all, we want to be **in control** of our software. We use Git\(hub\) to do version management. We use git flow strategy. We have a master branch that holds the code of the latest stable release. Then we have a development branch that holds the latest added features and bugfixes. We want this branch to be stable too. It must be buildable at all times, and no half-on-its-way functionality should be in it. For new features or other issues, we use feature branches. These branches are work in progress. They might be buildable, or they might not. Feature branches should be used for work in progress only. This keeps the amount of branches manageable. Tags can be created for all kind of other reference purposes to specific commits.

{% hint style="info" %}
:::info

To learn more about Git, head over to [this documentation](https://git-scm.com/).
{% endhint %}

:::

#### Automatic build & test

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@ The proper use of Docker ensures that your application will run on any location

## The desired result

{% hint style="success" %}
:::tip

When the following experiments are successful on your computer, you may consider this requirement to be fulfilled
{% endhint %}

:::

First demonstrate that an arbitrary internet domain (here: `nu.nl`) is visible.

Expand Down
22 changes: 13 additions & 9 deletions docs/the-tools-we-use/group-1/development-using-vs-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,24 +28,26 @@ stack install ormolu



{% hint style="info" %}
:::tip

If you use the devcontainer functionality (available in vscode), your code is auto-formatted by default. In other cases, you need to do that yourself. When merging code into the main branch, it should be formatted correctly. You can autoformat all haskell files with the command:

```bash
stack exec ormolu -- --mode inplace $(git ls-files '*.hs')
```
{% endhint %}

:::

### Devcontainer

We provide a standard developer container to the developers of Ampersand. Documentation about this awsome VScode feature can be found [here](https://code.visualstudio.com/docs/remote/containers).
We provide a standard developer container to the developers of Ampersand. Documentation about this awesome VScode feature can be found [here](https://code.visualstudio.com/docs/remote/containers).

#### How to get started using the .devcontainer stuff

Setting up a Haskell environment with awsome tooling has never been as easy as today.
Setting up a Haskell environment with awesome tooling has never been as easy as today.

* Make sure you have vscode installed.
* Install the \`Remote - Containers\` extention.
* Install the \`Remote - Containers\` extension.
* Make sure Docker is running.
* Go to the directory where your Ampersand stuff resides, and type \`code .\`
* In the lower right corner, you will see a message: 
Expand All @@ -54,9 +56,11 @@ Setting up a Haskell environment with awsome tooling has never been as easy as t

* Push the button \`Reopen in Container\` and watch the show.

{% hint style="warning" %}
The first time, opening the development container will take quite some time. It will build some docker images and finally spin up the container. Fortunatly, this is one time only. 
{% endhint %}
:::warning

The first time, opening the development container will take quite some time. It will build some docker images and finally spin up the container. Fortunately, this is one time only. 

:::

* While you are waiting, you can watch the progress by inspecting the log. There will be a message containing a link to the log file. 

Expand All @@ -74,7 +78,7 @@ In this case, you can click on the status bar at the place where the 'remote con

</details>

* After everything is set up, open `Main.hs` . This will trigger the Haskell extention of vscode. Also here, the first time will take a while, because the project is being build. That includes all dependencies of Ampersand. If you want to see what is going on, go to the Output tab and open the dropdown called \`tasks\`. You will find the task building Ampersand:
* After everything is set up, open `Main.hs` . This will trigger the Haskell extension of vscode. Also here, the first time will take a while, because the project is being build. That includes all dependencies of Ampersand. If you want to see what is going on, go to the Output tab and open the dropdown called \`tasks\`. You will find the task building Ampersand:

![](../assets/image.png)

0 comments on commit 57aa5a5

Please sign in to comment.