Skip to content

Add Fsharp to the docs #561

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 31, 2023
Merged

Add Fsharp to the docs #561

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
703c2b8
Add Fsharp to the docs
Lagoja Jan 31, 2023
504459f
Fix URLs for badges in Quickstart (#560)
Lagoja Jan 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .github/workflows/cli-tests.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ concurrency:

on:
pull_request:
paths-ignore:
- 'docs/**'
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why deleting this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is part of Mike's quick fix for golangci-lint. Without it, the golangci-lint jobs will not run for docs changes, even though it's still required in order to merge

push:
branches:
- main
Expand Down
10 changes: 3 additions & 7 deletions docs/app/docs/devbox_examples/languages/csharp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: C#, F#, and .NET
title: C# and .NET
---

C#, F# and .NET projects can be easily generated in Devbox by adding the dotnet SDK to your project. You can then create new projects using `dotnet new`
C# and .NET projects can be easily generated in Devbox by adding the dotnet SDK to your project. You can then create new projects using `dotnet new`

[**Example Repo**](https://github.com/jetpack-io/devbox-examples/tree/main/development/csharp)

Expand All @@ -25,8 +25,4 @@ Other versions available include:

## Creating a new C# Project

`dotnet new console -lang "C#" -o <name>`

## Creating a new F# Project

`dotnet new console -lang "F#" -o <name>`
`dotnet new console -lang "C#" -o <name>`
28 changes: 28 additions & 0 deletions docs/app/docs/devbox_examples/languages/fsharp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: F# and .NET
---

F# and .NET projects can be easily generated in Devbox by adding the dotnet SDK to your project. You can then create new projects using `dotnet new`

[**Example Repo**](https://github.com/jetpack-io/devbox-examples/tree/main/development/fsharp)

## Adding .NET to your project

`devbox add dotnet-sdk`, or add the following to your `devbox.json`:

```json
"packages": [
"dotnet-sdk"
],
```
This will install .NET SDK 6.0

Other versions available include:

* dotnet-sdk_7 (version 7.0)
* dotnet-sdk_5 (version 5.0)
* dotnet-sdk_3 (version 3.1)

## Creating a new F# Project

`dotnet new console -lang "F#" -o <name>`
12 changes: 6 additions & 6 deletions docs/app/docs/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,13 @@ We’ll create a new development environment with the packages we need. These pa

Once you publish your Devbox project to Github, you can help other developers get started by adding the Devbox Badge to your repo. Please copy the code snippets below and paste them into your README.md to add the badge

![Devbox Dark Badge](../static/img/shield_galaxy.svg)
[![Built with Devbox](https://jetpack.io/img/devbox/shield_galaxy.svg)](https://jetpack.io/devbox/docs/contributor-quickstart/)

<Tabs>
<TabItem value='md' label='Markdown'>

```md
[![Built with Devbox](https://jetpack.io/devbox/img/shield_galaxy.svg)](https://jetpack.io/devbox/docs/contributor-quickstart/)
[![Built with Devbox](https://jetpack.io/img/devbox/shield_galaxy.svg)](https://jetpack.io/devbox/docs/contributor-quickstart/)
```

</TabItem>
Expand All @@ -101,7 +101,7 @@ Once you publish your Devbox project to Github, you can help other developers ge
```html
<a href="https://jetpack.io/devbox/docs/contributor-quickstart/">
<img
src="https://jetpack.io/devbox/img/shield_galaxy.svg"
src="https://jetpack.io/img/devbox/shield_galaxy.svg"
alt="Built with Devbox"
/>
</a>
Expand All @@ -110,13 +110,13 @@ Once you publish your Devbox project to Github, you can help other developers ge
</TabItem>
</Tabs>

![Devbox Light Badge](../static/img/shield_moon.svg)
[![Built with Devbox](https://jetpack.io/img/devbox/shield_moon.svg)](https://jetpack.io/devbox/docs/contributor-quickstart/)

<Tabs>
<TabItem value='md' label='Markdown'>

```md
[![Built with Devbox](https://jetpack.io/devbox/img/shield_moon.svg)](https://jetpack.io/devbox/docs/contributor-quickstart/)
[![Built with Devbox](https://jetpack.io/img/devbox/shield_moon.svg)](https://jetpack.io/devbox/docs/contributor-quickstart/)
```

</TabItem>
Expand All @@ -125,7 +125,7 @@ Once you publish your Devbox project to Github, you can help other developers ge
```html
<a href="https://jetpack.io/devbox/docs/contributor-quickstart/">
<img
src="https://jetpack.io/devbox/img/shield_moon.svg"
src="https://jetpack.io/img/devbox/shield_moon.svg"
alt="Built with Devbox"
/>
</a>
Expand Down
4 changes: 4 additions & 0 deletions docs/app/sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,10 @@ const sidebars = {
type: 'doc',
id: 'devbox_examples/languages/elixir'
},
{
type: 'doc',
id: 'devbox_examples/languages/fsharp'
},
{
type: 'doc',
id: 'devbox_examples/languages/go'
Expand Down