Skip to content

Commit 03460b3

Browse files
authored
Merge pull request #2350 from bishabosha/move-contribute-from-scala-lang-pr
Migrate contribute section from scala-lang to a guide
2 parents 0afef9f + add60f3 commit 03460b3

33 files changed

+1602
-187
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ For more details on the Docker option, see [this issue](https://github.com/scala
2727

2828
## Contributing ##
2929

30-
Please have a look at [https://docs.scala-lang.org/contribute.html](https://docs.scala-lang.org/contribute.html) before making a contribution.
30+
Please have a look at [Add New Guides/Tutorials](https://docs.scala-lang.org/contribute/add-guides.html) before making a contribution.
3131
This document gives an overview of the type of documentation contained within the Scala Documentation repository and the repository's structure.
3232

3333
Small changes, or corrected typos will generally be pulled in right away. Large changes, like the addition of new documents, or the rewriting of

_config.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ scala-212-version: 2.12.15
2020
scala-3-version: 3.1.1
2121

2222
collections:
23+
contribute_resources:
2324
style:
2425
output: true
2526
overviews:
@@ -104,6 +105,14 @@ defaults:
104105
overview-name: "Scala 3 — Book"
105106
layout: multipage-overview
106107
permalink: "/scala3/book/:title.html"
108+
-
109+
scope:
110+
path: "_overviews/contribute"
111+
values:
112+
partof: scala-contribution
113+
overview-name: Contributing to Scala
114+
layout: multipage-overview
115+
permalink: "/contribute/:title.html"
107116
-
108117
scope:
109118
path: "_overviews/scala3-migration"
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Documentation
3+
link: /contribute/documentation.html
4+
icon: fa fa-book
5+
---
6+
[Library API docs][scala-standard-library-api-documentation], [new guides][add-guides] on [docs.scala-lang.org][home], and help
7+
with [scala-lang.org](https://github.com/scala/scala-lang).
8+
9+
[add-guides]: {% link _overviews/contribute/add-guides.md %}
10+
[scala-standard-library-api-documentation]: {% link _overviews/contribute/scala-standard-library-api-documentation.md %}
11+
[home]: {% link index.md %}

_contribute_resources/2-bug-fixes.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: Bug fixes
3+
link: /contribute/guide.html
4+
icon: fa fa-bug
5+
---
6+
Issues with the tools, core libraries and compiler. Also you can help us by [reporting bugs][bug-reporting-guide].
7+
8+
[bug-reporting-guide]: {% link _overviews/contribute/bug-reporting-guide.md %}
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Code Reviews
3+
link: /contribute/codereviews.html
4+
icon: fa fa-eye
5+
---
6+
Review pull requests against [scala/scala](https://github.com/scala/scala/pulls),
7+
[lampepfl/dotty](https://github.com/lampepfl/dotty/pulls),
8+
[scala/scala-lang](https://github.com/scala/scala-lang/pulls),
9+
[scala/docs.scala-lang](https://github.com/scala/docs.scala-lang/pulls) and others.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Core Libraries
3+
link: /contribute/corelibs.html
4+
icon: fa fa-clipboard
5+
---
6+
Update and expand the capabilities of the core (and associated) Scala libraries.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: IDE and Build Tools
3+
link: /contribute/tools.html
4+
icon: fa fa-terminal
5+
---
6+
Enhance the Scala tools with features for build tools, IDE plug-ins and other related projects.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Compiler/Language
3+
link: /contribute/guide.html#larger-changes-new-features
4+
icon: fa fa-cogs
5+
---
6+
Larger language features and compiler enhancements including language specification and SIPs.

_data/doc-nav-header.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@
3535
url: "/tutorials/FAQ/index.html"
3636
- title: Language Specification
3737
url: http://scala-lang.org/files/archive/spec/2.13/
38+
- title: Contribution Guide
39+
url: "/contribute/"
3840
- title: Style Guide
3941
url: "/style/index.html"
4042
- title: Cheatsheet

_data/nav-header.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
11
- title: Documentation
22
url: "/"
3+
can-highlight: true
34
- title: Download
45
url: https://www.scala-lang.org/download/
6+
can-highlight: true
57
- title: Community
68
url: https://www.scala-lang.org/community/
9+
can-highlight: true
710
- title: Libraries
811
url: https://index.scala-lang.org
12+
can-highlight: true
913
- title: Contribute
10-
url: https://www.scala-lang.org/contribute/
14+
url: /contribute/
1115
- title: Blog
1216
url: https://www.scala-lang.org/blog/
17+
can-highlight: true

0 commit comments

Comments
 (0)