Skip to content

Commit

Permalink
Warn about experimental features in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Gedochao committed Mar 17, 2023
1 parent 9322a21 commit 38a5592
Show file tree
Hide file tree
Showing 6 changed files with 49 additions and 1 deletion.
8 changes: 8 additions & 0 deletions website/docs/commands/export.md
Expand Up @@ -17,6 +17,14 @@ You can pass it explicitly or set it globally by running:
scala-cli config power true
:::

:::caution
The `export` sub-command is an experimental feature.

Please bear in mind that non-ideal user experience should be expected.
If you encounter any bugs or have feedback to share, make sure to reach out to the maintenance team
on [GitHub](https://github.com/VirtusLab/scala-cli).
:::

The project configuration is read both from information specified in source files
as well as options passed to the `export` sub-command.

Expand Down
8 changes: 8 additions & 0 deletions website/docs/commands/publishing/publish-local.md
Expand Up @@ -10,6 +10,14 @@ You can pass it explicitly or set it globally by running:
scala-cli config power true
:::

:::caution
The `publish local` sub-command is an experimental feature.

Please bear in mind that non-ideal user experience should be expected.
If you encounter any bugs or have feedback to share, make sure to reach out to the maintenance team
on [GitHub](https://github.com/VirtusLab/scala-cli).
:::

import {ChainedSnippets} from "../../../src/components/MarkdownComponents.js";

The `publish local` sub-command publishes a Scala CLI project in the local Ivy2
Expand Down
8 changes: 8 additions & 0 deletions website/docs/commands/publishing/publish-setup.md
Expand Up @@ -10,6 +10,14 @@ You can pass it explicitly or set it globally by running:
scala-cli config power true
:::

:::caution
The `publish setup` sub-command is an experimental feature.

Please bear in mind that non-ideal user experience should be expected.
If you encounter any bugs or have feedback to share, make sure to reach out to the maintenance team
on [GitHub](https://github.com/VirtusLab/scala-cli).
:::

import {ChainedSnippets} from "../../../src/components/MarkdownComponents.js";

The `publish setup` sub-command configures your project for publishing to Maven repositories,
Expand Down
8 changes: 8 additions & 0 deletions website/docs/commands/publishing/publish.md
Expand Up @@ -10,6 +10,14 @@ You can pass it explicitly or set it globally by running:
scala-cli config power true
:::

:::caution
The `publish` sub-command is an experimental feature.

Please bear in mind that non-ideal user experience should be expected.
If you encounter any bugs or have feedback to share, make sure to reach out to the maintenance team
on [GitHub](https://github.com/VirtusLab/scala-cli).
:::

import {ChainedSnippets} from "../../../src/components/MarkdownComponents.js";

The `publish` sub-command allows to publish Scala CLI projects to Maven repositories.
Expand Down
10 changes: 9 additions & 1 deletion website/docs/guides/markdown.md
@@ -1,8 +1,16 @@
---
title: Markdown (experimental) ⚡️
title: Markdown ⚡️
sidebar_position: 60
---

:::caution
Markdown support is an experimental feature.

Please bear in mind that non-ideal user experience should be expected.
If you encounter any bugs or have feedback to share, make sure to reach out to the maintenance team
on [GitHub](https://github.com/VirtusLab/scala-cli).
:::

import {ChainedSnippets} from "../../src/components/MarkdownComponents.js";

Scala CLI can compile, run, test, and package markdown (`.md`) sources.
Expand Down
8 changes: 8 additions & 0 deletions website/docs/guides/sbt-mill.md
Expand Up @@ -3,6 +3,14 @@ title: SBT and Mill ⚡️
sidebar_position: 50
---

:::caution
The `export` sub-command is an experimental feature.

Please bear in mind that non-ideal user experience should be expected.
If you encounter any bugs or have feedback to share, make sure to reach out to the maintenance team
on [GitHub](https://github.com/VirtusLab/scala-cli).
:::

Scala CLI lets you export your current build into sbt or Mill.
This means that if your project needs something that Scala CLI doesn’t provide — such as a second module — you can export your project to your build tool of choice.

Expand Down

0 comments on commit 38a5592

Please sign in to comment.