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 16, 2023
1 parent 5e6aa51 commit dbca684
Show file tree
Hide file tree
Showing 6 changed files with 107 additions and 1 deletion.
17 changes: 17 additions & 0 deletions website/docs/commands/export.md
Expand Up @@ -17,6 +17,23 @@ 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).

Experimental features' warnings can be suppressed with the `--suppress-experimental-warning` option.
```bash ignore
scala-cli --power export --suppress-experimental-warning
```
Alternatively, you can configure the warnings to be suppressed globally by running:
```bash
scala-cli config suppress-warning.experimental-features true
```
:::

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

Expand Down
17 changes: 17 additions & 0 deletions website/docs/commands/publishing/publish-local.md
Expand Up @@ -10,6 +10,23 @@ 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).

Experimental features' warnings can be suppressed with the `--suppress-experimental-warning` option.
```bash ignore
scala-cli --power publish local --suppress-experimental-warning
```
Alternatively, you can configure the warnings to be suppressed globally by running:
```bash
scala-cli config suppress-warning.experimental-features true
```
:::

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

The `publish local` sub-command publishes a Scala CLI project in the local Ivy2
Expand Down
17 changes: 17 additions & 0 deletions website/docs/commands/publishing/publish-setup.md
Expand Up @@ -10,6 +10,23 @@ 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).

Experimental features' warnings can be suppressed with the `--suppress-experimental-warning` option.
```bash ignore
scala-cli --power publish setup --suppress-experimental-warning
```
Alternatively, you can configure the warnings to be suppressed globally by running:
```bash
scala-cli config suppress-warning.experimental-features true
```
:::

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

The `publish setup` sub-command configures your project for publishing to Maven repositories,
Expand Down
17 changes: 17 additions & 0 deletions website/docs/commands/publishing/publish.md
Expand Up @@ -10,6 +10,23 @@ 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).

Experimental features' warnings can be suppressed with the `--suppress-experimental-warning` option.
```bash ignore
scala-cli --power publish --suppress-experimental-warning
```
Alternatively, you can configure the warnings to be suppressed globally by running:
```bash
scala-cli config suppress-warning.experimental-features true
```
:::

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

The `publish` sub-command allows to publish Scala CLI projects to Maven repositories.
Expand Down
23 changes: 22 additions & 1 deletion website/docs/guides/markdown.md
@@ -1,8 +1,29 @@
---
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).

Experimental features' warnings can be suppressed with the `--suppress-experimental-warning` option.
````bash
scala-cli --power run --suppress-experimental-warning --markdown-snippet '# Markdown snippet
with a code block
```scala
println("Hello")
```'
````
Alternatively, you can configure the warnings to be suppressed globally by running:
```bash
scala-cli config suppress-warning.experimental-features true
```
:::

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

Scala CLI can compile, run, test, and package markdown (`.md`) sources.
Expand Down
17 changes: 17 additions & 0 deletions website/docs/guides/sbt-mill.md
Expand Up @@ -3,6 +3,23 @@ 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).

Experimental features' warnings can be suppressed with the `--suppress-experimental-warning` option.
```bash ignore
scala-cli --power export --suppress-experimental-warning
```
Alternatively, you can configure the warnings to be suppressed globally by running:
```bash
scala-cli config suppress-warning.experimental-features true
```
:::

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 dbca684

Please sign in to comment.