10000 master is now main by SethTisue · Pull Request #2063 · scala/docs.scala-lang · GitHub
[go: up one dir, main page]
Skip to content

master is now main #2063

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 1 commit into from
Jun 3, 2021
Merged

master is now main #2063

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ jobs:
run: bundle exec jekyll build
- name: HTMLProofer
run: |
# # Checking for docs.scala-lang/blob/master leads to a chicken and egg problem because of the edit links of new pages.
# # Checking for docs.scala-lang/blob/main leads to a chicken and egg problem because of the edit links of new pages.
bundle exec htmlproofer ./_site/\
--only-4xx\
--http-status-ignore "400,401,429"\
--empty-alt-ignore\
--allow-hash-href\
--url-ignore '/https://github.com/scala/docs.scala-lang/blob/master/.*/,/www.oracle.com/'
--url-ignore '/https://github.com/scala/docs.scala-lang/blob/main/.*/,/www.oracle.com/'

2 changes: 1 addition & 1 deletion _includes/sidebar-toc-glossary.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ <h5 class="contents">Terms</h5>
<div id="toc"></div>
</div>
<hr>
<div class="help-us"><a href="https://github.com/scala/docs.scala-lang/blob/master/{% if page.collection %}{{ page.relative_path }}{% else %}{{ page.path }}{% endif %}"><i class="fa fa-pencil" aria-hidden="true"></i> Problem with this page?<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Please help us fix it!</a></div>
<div class="help-us"><a href="https://github.com/scala/docs.scala-lang/blob/main/{% if page.collection %}{{ page.relative_path }}{% else %}{{ page.path }}{% endif %}"><i class="fa fa-pencil" aria-hidden="true"></i> Problem with this page?<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Please help us fix it!</a></div>
</div>
</div>
2 changes: 1 addition & 1 deletion _includes/sidebar-toc-multipage-overview.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,6 @@ <h5 class="contents">Contents</h5>
{% endif %}
</div>
<hr>
<div class="help-us"><a href="https://github.com/scala/docs.scala-lang/blob/master/{% if page.collection %}{{ page.relative_path }}{% else %}{{ page.path }}{% endif %}"><i class="fa fa-pencil" aria-hidden="true"></i> Problem with this page?<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Please help us fix it!</a></div>
<div class="help-us"><a href="https://github.com/scala/docs.scala-lang/blob/main/{% if page.collection %}{{ page.relative_path }}{% else %}{{ page.path }}{% endif %}"><i class="fa fa-pencil" aria-hidden="true"></i> Problem with this page?<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Please help us fix it!</a></div>
</div>
</div>
2 changes: 1 addition & 1 deletion _includes/sidebar-toc-singlepage-overview.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ <h5 class="contents">Contents</h5>
{% endif %}
</div>
<hr>
<div class="help-us"><a href="https://github.com/scala/docs.scala-lang/blob/master/{% if page.collection %}{{ page.relative_path }}{% else %}{{ page.path }}{% endif %}"><i class="fa fa-pencil" aria-hidden="true"></i> Problem with this page?<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Please help us fix it!</a></div>
<div class="help-us"><a href="https://github.com/scala/docs.scala-lang/blob/main/{% if page.collection %}{{ page.relative_path }}{% else %}{{ page.path }}{% endif %}"><i class="fa fa-pencil" aria-hidden="true"></i> Problem with this page?<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Please help us fix it!</a></div>
</div>
</div>
2 changes: 1 addition & 1 deletion _includes/sidebar-toc-style.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ <h5 class="contents">Contents</h5>
{% endif %}
</div>
<hr>
<div class="help-us"><a href="https://github.com/scala/docs.scala-lang/blob/master/{% if page.collection %}{{ page.relative_path }}{% else %}{{ page.path }}{% endif %}"><i class="fa fa-pencil" aria-hidden="true"></i> Problem with this page?<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Please help us fix it!</a></div>
<div class="help-us"><a href="https://github.com/scala/docs.scala-lang/blob/main/{% if page.collection %}{{ page.relative_path }}{% else %}{{ page.path }}{% endif %}"><i class="fa fa-pencil" aria-hidden="true"></i> Problem with this page?<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Please help us fix it!</a></div>
</div>
</div>
{% endif %}
Expand Down
2 changes: 1 addition & 1 deletion _includes/sidebar-toc-tour-overview.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,6 @@ <h5 class="contents">Contents</h5>
{% endif %}
</div>
<hr>
<div class="help-us"><a href="https://github.com/scala/docs.scala-lang/blob/master/{% if page.collection %}{{ page.relative_path }}{% else %}{{ page.path }}{% endif %}"><i class="fa fa-pencil" aria-hidden="true"></i> Problem with this page?<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Please help us fix it!</a></div>
<div class="help-us"><a href="https://github.com/scala/docs.scala-lang/blob/main/{% if page.collection %}{{ page.relative_path }}{% else %}{{ page.path }}{% endif %}"><i class="fa fa-pencil" aria-hidden="true"></i> Problem with this page?<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Please help us fix it!</a></div>
</div>
</div>
2 changes: 1 addition & 1 deletion _includes/sidebar-toc.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ <h5 class="contents">Contents</h5>
{% endif %}
</div>
<hr>
<div class="help-us"><a href="https://github.com/scala/docs.scala-lang/blob/master/{% if page.collection %}{{ page.relative_path }}{% else %}{{ page.path }}{% endif %}"><i class="fa fa-pencil" aria-hidden="true"></i> Problem with this page?<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Please help us fix it!</a></div>
<div class="help-us"><a href="https://github.com/scala/docs.scala-lang/blob/main/{% if page.collection %}{{ page.relative_path }}{% else %}{{ page.path }}{% endif %}"><i class="fa fa-pencil" aria-hidden="true"></i> Problem with this page?<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Please help us fix it!</a></div>
</div>
</div>
{% endif %}
Expand Down
2 changes: 1 addition & 1 deletion < 6D4E a title="_includes/tutorial-toc.html" class="Link--primary Truncate-text" href="#diff-5d84a2f9cd5e5784c969f0ba6ac0fe205c7ccd8c5eac39f668a736cb40ac70f2">_includes/tutorial-toc.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ <h5>Contents</h5>
{% include tutorial-tour-list.txt %}
</div>
<hr>
<div class="help-us"><a href="https://github.com/scala/docs.scala-lang/blob/master/{% if page.collection %}{{ page.relative_path }}{% else %}{{ page.path }}{% endif %}"><i class="fa fa-pencil" aria-hidden="true"></i> Problem with this page?<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Please help us fix it!</a></div>
<div class="help-us"><a href="https://github.com/scala/docs.scala-lang/blob/main/{% if page.collection %}{{ page.relative_path }}{% else %}{{ page.path }}{% endif %}"><i class="fa fa-pencil" aria-hidden="true"></i> Problem with this page?<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Please help us fix it!</a></div>
</div>
</div>
4 changes: 2 additions & 2 deletions _includes/upcoming-training.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,6 @@ <h4>{{training.title}}</h4>
{% endfor %}
</div>
<div class="call-to-action action-medium">
<p class="align-top">See <a href="/training/">more training</a> or <a href="https://github.com/scala/scala-lang/tree/master/training">add one to our feed</a></p>
<p class="align-top">See <a href="/training/">more training</a> or <a href="https://github.com/scala/scala-lang/tree/main/training">add one to our feed</a></p>
</div>
</div>
</div>
6 changes: 3 additions & 3 deletions _ja/scala3/contribute-to-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,19 @@ Scala 3 の高品質なドキュメンテーションを作るためのいくつ
## Scala 3 Book
[Scala 3 Book][scala3-book] は Alvin Alexander 氏 が書いている。 この本は Scala 3 のすべての重要な機能の概説書である。これから Scala を使いはじめる読者を対象にしている。

- [Sources](https://github.com/scala/docs.scala-lang/tree/master/_overviews/scala3-book)
- [Sources](https://github.com/scala/docs.scala-lang/tree/main/_overviews/scala3-book)
- [Issues](https://github.com/scala/docs.scala-lang/issues)

## Macros Tutorial
[Macros Tutorial](/scala3/guides/macros)は Nicolas Stucki 氏 が書いている。この本では Scala 3 のマクロとそのベストプラクティスについて詳しく説明している。

- [Sources](https://github.com/scala/docs.scala-lang/tree/master/_overviews/scala3-macros)
- [Sources](https://github.com/scala/docs.scala-lang/tree/main/_overviews/scala3-macros)
- [Issues](https://github.com/scala/docs.scala-lang/issues)

## Migration Guide
[Scala 3 Migration Guide](/scala3/guides/migration/compatibility-intro.html) は Scala 2 と Scala 3 の互換性、移行に役立つツールの紹介、そして詳しい移行のガイドを含んだ包括的なドキュメントである。

- [Source](https://github.com/scala/docs.scala-lang/tree/master/_overviews/scala3-migration)
- [Source](https://github.com/scala/docs.scala-lang/tree/main/_overviews/scala3-migration)
- [Issues](https://github.com/scalacenter/docs.scala-lang/issues)


Expand Down
4 changes: 2 additions & 2 deletions _layouts/frontpage.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ <h4>{{event.title}}</h4>
{% endfor %}
</div>
<div class="call-to-action action-medium">
<p class="align-top">See <a href="/events/">more events</a> or <a href="https://github.com/scala/scala-lang/tree/master/events">add one to our feed</a></p>
<p class="align-top">See <a href="/events/">more events</a> or <a href="https://github.com/scala/scala-lang/tree/main/events">add one to our feed</a></p>
</div>
</div>
</section>
Expand Down Expand Up @@ -383,4 +383,4 @@ <h3>{{site.data.common.texts.scalaSupportersTitle}}</h3>
</section>
</main>

{% include footer.html %}
{% include footer.html %}
2 changes: 1 addition & 1 deletion _layouts/sip.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ <h5 class="contents">SIP Contents</h5>
<div id="toc"></div>
</div>
<hr>
<div class="help-us"><a href="https://github.com/scala/docs.scala-lang/blob/master/{% if page.collection %}{{ page.relative_path }}{% else %}{{ page.path }}{% endif %}"><i class="fa fa-pencil" aria-hidden="true"></i> Problem with this page?<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Please help us fix it!</a></div>
<div class="help-us"><a href="https://github.com/scala/docs.scala-lang/blob/main/{% if page.collection %}{{ page.relative_path }}{% else %}{{ page.path }}{% endif %}"><i class="fa fa-pencil" aria-hidden="true"></i> Problem with this page?<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Please help us fix it!</a></div>
</div>
</div>

Expand Down
2 changes: 1 addition & 1 deletion _layouts/sips.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ <h5 class="contents" style="margin-bottom: 0;">Writing a SIP</h5>
<li><a href="{{ site.baseurl }}/sips/sip-submission.html">Submitting a SIP</a></li>
<li><a href="{{ site.baseurl }}/sips/sip-tutorial.html">Tutorial: Writing a SIP</a></li>
</ul>
<div class="help-us"><a href="https://github.com/scala/docs.scala-lang/blob/master/{% if page.collection %}{{ page.relative_path }}{% else %}{{ page.path }}{% endif %}"><i class="fa fa-pencil" aria-hidden="true"></i> Problem with this page?<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Please help us fix it!</a></div>
<div class="help-us"><a href="https://github.com/scala/docs.scala-lang/blob/main/{% if page.collection %}{{ page.relative_path }}{% else %}{{ page.path }}{% endif %}"><i class="fa fa-pencil" aria-hidden="true"></i> Problem with this page?<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Please help us fix it!</a></div>
</div>
</div>

Expand Down
2 changes: 1 addition & 1 deletion _overviews/contributors/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -742,7 +742,7 @@ Last, add the following job to the “test” stage, in the `.travis.yml` file:
This will check that pull requests don’t make changes that are binary incompatible with the
previous stable version.

We suggest working with the following Git workflow: the `master` branch always receives pull requests
We suggest working with the following Git workflow: the `main` branch always receives pull requests
for the next major version (so, binary compatibility checks are disabled, by setting the `mimaPreviousArtifacts`
value to `Set.empty`), and each major version `N` has a corresponding `N.x` branch (e.g., `1.x`, `2.x`, etc.) branch
where the binary compatibility checks are enabled.
4 changes: 2 additions & 2 deletions _sips/sip-submission.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ a SIP or needs more work.
After receiving the green light from the Process Lead, you can write up your
idea and submit it as a SIP.

A SIP is a Markdown document written in conformance with the [process template](https://github.com/scala/docs.scala-lang/blob/master/_sips/sip-template.md).
A SIP is a Markdown document written in conformance with the [process template](https://github.com/scala/docs.scala-lang/blob/main/_sips/sip-template.md).
It ought to contain a clear specification of the proposed changes. When such
changes significantly alter the compiler internals, the author is invited to
provide a proof of concept. Delivering a basic implementation can speed up the
Expand Down Expand Up @@ -323,7 +323,7 @@ Scala compiler.
The process to submit is simple:

* Fork the Scala documentation repository, [https://github.com/scala/docs.scala-lang](https://github.com/scala/docs.scala-lang).
* Create a new SIP file in the `_sips/sips/`. Use the [S(L)IP template](https://github.com/scala/docs.scala-lang/blob/master/_sips/sip-template.md)
* Create a new SIP file in the `_sips/sips/`. Use the [S(L)IP template](https://github.com/scala/docs.scala-lang/blob/main/_sips/sip-template.md)
* Make sure the new file follows the format: `YYYY-MM-dd-{title}.md`. Use the proposal date for `YYYY-MM-dd`.
* Use the [Markdown Syntax](https://daringfireball.net/projects/markdown/syntax) to write your SIP.
* Follow the instructions in the [README](https://github.com/scala/docs.scala-lang/) to build your SIP locally so you can ensure that it looks correct on the website.
Expand Down
8 changes: 4 additions & 4 deletions _sips/sip-tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ This tutorial details of how to write a new SIP and adding it to the website.
The process to submit is simple:

* Fork the [Scala documentation repository](https://github.com/scala/docs.scala-lang) and clone it.
* Create a new SIP file in the `_sips/sips`. Use the [SIP template](https://github.com/scala/docs.scala-lang/blob/master/_sips/sip-template.md)
* Create a new SIP file in the `_sips/sips`. Use the [SIP template](https://github.com/scala/docs.scala-lang/blob/main/_sips/sip-template.md)
* Make sure the new file follows the format: `YYYY-MM-dd-{title}.md`. Use the proposal date for `YYYY-MM-dd`.
* Use the [Markdown Syntax](https://daringfireball.net/projects/markdown/syntax) to write your SIP.
* Follow the instructions in the [README](https://github.com/scala/docs.scala-lang/blob/master/README.md) to build your SIP locally so you can ensure that it looks correct on the website.
* Follow the instructions in the [README](https://github.com/scala/docs.scala-lang/blob/main/README.md) to build your SIP locally so you can ensure that it looks correct on the website.
* Create a link to your SIP in the "pending sips" section of `index.md`.
* Commit your changes and push them to your forked repository.
* Create a new pull request. This will notify the Scala SIP team.
Expand All @@ -34,7 +34,7 @@ Use the [Markdown Syntax](https://daringfireball.net/projects/markdown/syntax) t
If you would like a starting point, clone the [SIP Template](./sip-template.html) in
`_sips/sip-template.md` and use that.

See the [source](https://github.com/scala/docs.scala-lang/blob/master/_sips/sip-template.md) for this document (`sip-tutorial.md`) for how to do syntax highlighting.
See the [source](https://github.com/scala/docs.scala-lang/blob/main/_sips/sip-template.md) for this document (`sip-tutorial.md`) for how to do syntax highlighting.

```scala
class Foo
Expand All @@ -46,6 +46,6 @@ class Foo
Testing changes requires installing [Jekyll](https://jekyllrb.com/docs/installation/). Since this site is hosted on github pages, make sure you have [whatever version of Jekyll that github is running](https://help.github.com/articles/using-jekyll-with-pages#troubleshooting). As of the writing of this README, that is version >= 1.0.x.

After the installation, you need to start up the local server. The
[README](https://github.com/scala/docs.scala-lang/blob/master/README.md) gives
[README](https://github.com/scala/docs.scala-lang/blob/main/README.md) gives
a concise explanation on how to do it. When the server is running, view your
changes at [https://localhost:4000/sips](https://localhost:4000/sips).
6 changes: 3 additions & 3 deletions scala3/contribute-to-docs.md
View file
Open in desktop

Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,21 @@ Typically, each of the different documentation projects contain links (and so do
## Scala 3 Book
The [Scala 3 Book][scala3-book] is being written by Alvin Alexander and provides an overview over all the important features of Scala 3. It targets readers, which are new to Scala.
- [Sources](https://github.com/scala/docs.scala-lang/tree/master/_overviews/scala3-book)
- [Sources](https://github.com/scala/docs.scala-lang/tree/main/_overviews/scala3-book)
- [Issues](https://github.com/scala/docs.scala-lang/issues)

## Macros Tutorial
The [Macros Tutorial](/scala3/guides/macros) is being written by Nicolas Stucki and contains detailed information about macros in Scala 3 and best-practices.

- [Sources](https://github.com/scala/docs.scala-lang/tree/master/_overviews/scala3-macros)
- [Sources](https://github.com/scala/docs.scala-lang/tree/main/_overviews/scala3-macros)
- [Issues](https://github.com/scala/docs.scala-lang/issues)

## Migration Guide
The [Scala 3 Migration Guide](/scala3/guides/migration/compatibility-intro.html)
contains an comprehensive overview over compatibility between Scala 2 and Scala 3,
a tour presenting the migration tools, and detailed migration guides.

- [Source](https://github.com/scala/docs.scala-lang/tree/master/_overviews/scala3-migration)
- [Source](https://github.com/scala/docs.scala-lang/tree/main/_overviews/scala3-migration)
- [Issues](https://github.com/scalacenter/docs.scala-lang/issues)

## Scala 3 Language Reference
Expand Down
0