Skip to content

Update getting started project names in the docs #10698

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.

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 5 commits into from
Dec 8, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions docs/_includes/getting-started.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ <h1 id="getting-started-with-a-project">Create a Dotty Project</h1>
<p>The fastest way to create a new project in Dotty is using <a href="http://www.scala-sbt.org/">sbt (1.1.4+)</a>.</p>

<p>Create a Dotty project:</p>
<pre><code>sbt new <a href="https://github.com/lampepfl/dotty.g8">lampepfl/dotty.g8</a></code></pre>
<pre><code>sbt new <a href="https://github.com/scala/scala3.g8">scala/scala3.g8</a></code></pre>

<p>Or a Dotty project that cross compiles with Scala 2:</p>
<pre><code>sbt new <a href="https://github.com/lampepfl/dotty-cross.g8">lampepfl/dotty-cross.g8</a></code></pre>
<pre><code>sbt new <a href="https://github.com/scala/scala3-cross.g8">scala/scala3-cross.g8</a></code></pre>

<p>For documentation see the <a href="https://github.com/lampepfl/dotty-example-project">Dotty Example Project</a>.</p>
<p>For documentation see the <a href="https://github.com/scala/scala3-example-project">Dotty Example Project</a>.</p>
</div>
</section>
8 changes: 4 additions & 4 deletions docs/docs/contributing/checklist.sh
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ LIST='- [ ] Publish artifacts to Maven via CI
- [ ] On `<rc-branch>`, set `baseVersion` to `<rc-version>` and `git tag` it as `<rc-version>`. This will publish artefacts to Sonatype and GitHub Release.
- [ ] On `master`, set `baseVersion` to `<next-version>`
- [ ] Update `scalaVersion` (and, if applicable, the `sbt-dotty` version) in the Dotty ecosystem projects
- [ ] https://github.com/lampepfl/dotty-example-project [![Build Status](https://travis-ci.org/lampepfl/dotty-example-project.svg?branch=master)](https://travis-ci.org/lampepfl/dotty-example-project)
- [ ] https://github.com/scala/scala3-example-project [![Build Status](https://travis-ci.org/scala/scala3-example-project.svg?branch=master)](https://travis-ci.org/scala/scala3-example-project)
- [ ] Committed to `master`
- [ ] https://github.com/lampepfl/dotty-example-project/tree/mill
- [ ] https://github.com/lampepfl/dotty.g8 [![Build Status](https://travis-ci.org/lampepfl/dotty.g8.svg?branch=master)](https://travis-ci.org/lampepfl/dotty.g8/)
- [ ] https://github.com/scala/scala3-example-project/tree/mill
- [ ] https://github.com/scala/scala3.g8 [![Build Status](https://travis-ci.org/scala/scala3.g8.svg?branch=master)](https://travis-ci.org/scala/scala3.g8/)
- [ ] Committed to `master`
- [ ] https://github.com/lampepfl/dotty-cross.g8 [![Build Status](https://travis-ci.org/lampepfl/dotty-cross.g8.svg?branch=master)](https://travis-ci.org/lampepfl/dotty-cross.g8/)
- [ ] https://github.com/scala/scala3-cross.g8 [![Build Status](https://travis-ci.org/scala/scala3-cross.g8.svg?branch=master)](https://travis-ci.org/scala/scala3-cross.g8/)
- [ ] Committed to `master`
- [ ] https://github.com/lampepfl/homebrew-brew [![Build Status](https://travis-ci.org/lampepfl/homebrew-brew.svg?branch=master)](https://travis-ci.org/lampepfl/homebrew-brew)
- [ ] Committed to `master`
Expand Down
24 changes: 12 additions & 12 deletions docs/docs/contributing/procedures/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,22 +71,22 @@ After the release is done, we document it as follows:
## Ecosystem
After releasing a new version of Dotty, we need to make sure to update the following related projects:

- [Example Project](https://github.com/lampepfl/dotty-example-project)
- To deploy locally: `git clone https://github.com/lampepfl/dotty-example-project.git && cd dotty-example-project/`
- [Example Project](https://github.com/scala/scala3-example-project)
- To deploy locally: `git clone https://github.com/scala/scala3-example-project.git && cd dotty-example-project/`
- To test locally: `sbt run`
- [Commit](https://github.com/lampepfl/dotty-example-project/commit/76bf0b4d708206b1901fa7f291f07cd470506e79) updating the Dotty version (only `README` and `build.sbt` files)
- [Example Project with Mill](https://github.com/lampepfl/dotty-example-project/tree/mill)
- Deploy: `git clone https://github.com/lampepfl/dotty-example-project && cd dotty-example-project && git checkout mill`
- [Commit](https://github.com/scala/scala3-example-project/commit/76bf0b4d708206b1901fa7f291f07cd470506e79) updating the Dotty version (only `README` and `build.sbt` files)
- [Example Project with Mill](https://github.com/scala/scala3-example-project/tree/mill)
- Deploy: `git clone https://github.com/scala/scala3-example-project && cd dotty-example-project && git checkout mill`
- Test: `mill root.run`
- [Commit 1](https://github.com/lampepfl/dotty-example-project/commit/e1ad1905ef38d07943e0c176333ba24e306a2078) – `build.sc` only; [Commit 2](https://github.com/lampepfl/dotty-example-project/commit/23bc5df89e72b782ab8e19157d6bbcb67eef30cd)
- [Dotty G8 template](https://github.com/lampepfl/dotty.g8)
- Deploy: `git clone https://github.com/lampepfl/dotty.g8.git`
- [Commit 1](https://github.com/scala/scala3-example-project/commit/e1ad1905ef38d07943e0c176333ba24e306a2078) – `build.sc` only; [Commit 2](https://github.com/scala/scala3-example-project/commit/23bc5df89e72b782ab8e19157d6bbcb67eef30cd)
- [Dotty G8 template](https://github.com/scala/scala3.g8)
- Deploy: `git clone https://github.com/scala/scala3.g8.git`
- Test (note the relative path as argument to `sbt new`, hence this command should be run after Deploy in the same directory as Deploy): `sbt new file://./dotty.g8 --name=foo --description=bar && cd foo && sbt run`
- [Commit](https://github.com/lampepfl/dotty.g8/commit/0cde8fa843e15e916f07f22a196f35a5988b26af)
- [Dotty G8 template with cross build support](https://github.com/lampepfl/dotty-cross.g8)
- Deploy: `git clone https://github.com/lampepfl/dotty-cross.g8.git`
- [Commit](https://github.com/scala/scala3.g8/commit/0cde8fa843e15e916f07f22a196f35a5988b26af)
- [Dotty G8 template with cross build support](https://github.com/scala/scala3-cross.g8)
- Deploy: `git clone https://github.com/scala/scala3-cross.g8.git`
- Test: `sbt new file://./dotty-cross.g8 --name=foo --description=bar && cd foo && sbt run`
- [Commit](https://github.com/lampepfl/dotty-cross.g8/commit/0e3ea2ae8ba8d001e63e5098ff60d728036d358f)
- [Commit](https://github.com/scala/scala3-cross.g8/commit/0e3ea2ae8ba8d001e63e5098ff60d728036d358f)
- [Dotty Homebrew Formula](https://github.com/lampepfl/homebrew-brew)
- Deploy: `git clone https://github.com/lampepfl/homebrew-brew.git && cd homebrew-brew`
- [Commit](https://github.com/lampepfl/homebrew-brew/commit/04f7284564387754a360a354159f2f8d6156a6c7). SHA256 sum comes from the issue checklist computed for the release as specified above. The file with checksums is available at [GitHub Releases](https://github.com/lampepfl/dotty/releases) -> release in question -> assets -> `sha256sum.txt` -> `*.tar.gz` file sum.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/contributing/scala2-vs-scala3.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The following issues encountered when compiling Scala 2 code as-is under Dotty:

## Trivial
- Scala 2.13 libraries cannot be used from Dotty because the dotty-library is compiled against the 2.12 standard library which is not binary-compatible with the 2.13 one. We can't be compatible with both at the same time.
- To use Scala 2.12 dependencies from SBT with Dotty, use `withDottyCompat` as documented [here](https://github.com/lampepfl/dotty-example-project#getting-your-project-to-compile-with-dotty).
- To use Scala 2.12 dependencies from SBT with Dotty, use `withDottyCompat` as documented [here](https://github.com/scala/scala3-example-project#getting-your-project-to-compile-with-dotty).
- Feature warnings about implicits `scala.language.implicitConversions` are output by default, unlike in Scala 2. This creates noise. Unclear how to turn off.

Implicit conversions must be applied explicitly:
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/reference/metaprogramming/staging.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,10 @@ def withQuotes[T](thunk: Quotes ?=> T)(using toolbox: Toolbox): T = ...
## Create a new Dotty project with staging enabled

```shell
sbt new lampepfl/dotty-staging.g8
sbt new scala/scala3-staging.g8
```

From [lampepfl/dotty-staging.g8](https://github.com/lampepfl/dotty-staging.g8).
From [scala/scala3-staging.g8](https://github.com/scala/scala3-staging.g8).

It will create a project with the necessary dependencies and some examples.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/reference/metaprogramming/tasty-inspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,6 @@ scala -with-compiler -classpath out Test
## Template project
Using sbt version `1.1.5+`, do:
```
sbt new lampepfl/dotty-tasty-inspector.g8
sbt new scala/scala3-tasty-inspector.g8
```
in the folder where you want to clone the template.
6 changes: 3 additions & 3 deletions docs/docs/usage/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ The fastest way to create a new project compiled by Dotty is using [sbt (1.1.4+)

Create a simple Dotty project:
```bash
$ sbt new lampepfl/dotty.g8
$ sbt new scala/scala3.g8
```

Or a Dotty project that cross compiles with Scala 2:
```bash
$ sbt new lampepfl/dotty-cross.g8
$ sbt new scala/scala3-cross.g8
```

You can then start a Dotty REPL directly from your sbt project:
Expand All @@ -29,7 +29,7 @@ $ sbt
scala>
```

For more information, see the [Dotty Example Project](https://github.com/lampepfl/dotty-example-project)
For more information, see the [Dotty Example Project](https://github.com/scala/scala3-example-project)

### IDE support
Start using the Dotty IDE in any Dotty project by following the
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/usage/ide-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Currently, the only IDE we officially support is
Prerequisites
============
To use this in your own Scala project, you must first get it to compile with
Dotty, please follow the instructions at https://github.com/lampepfl/dotty-example-project
Dotty, please follow the instructions at https://github.com/scala/scala3-example-project

Usage
=====
Expand Down