Skip to content

Commit 302bfbf

Browse files
committed
revert to /contribute/ urls
1 parent 4b34e7f commit 302bfbf

25 files changed

+52
-83
lines changed

README.md

+1-1
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 [Add New Guides/Tutorials](https://docs.scala-lang.org/overviews/contribute/add-guides.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

+8
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,14 @@ defaults:
105105
overview-name: "Scala 3 — Book"
106106
layout: multipage-overview
107107
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"
108116
-
109117
scope:
110118
path: "_overviews/scala3-migration"
+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Documentation
3-
link: /overviews/contribute/documentation.html
3+
link: /contribute/documentation.html
44
icon: fa fa-book
55
---
6-
[Scaladoc (API)](/overviews/contribute/scala-standard-library-api-documentation.html), [docs.scala-lang.org](/overviews/contribute/add-guides.html) and [scala-lang.org](https://github.com/scala/scala-lang).
6+
[Scaladoc (API)](/contribute/scala-standard-library-api-documentation.html), [docs.scala-lang.org](/contribute/add-guides.html) and [scala-lang.org](https://github.com/scala/scala-lang).

_contribute_resources/2-bug-fixes.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Bug fixes
3-
link: /overviews/contribute/guide.html
3+
link: /contribute/guide.html
44
icon: fa fa-bug
55
---
6-
Issues with the tools, core libraries and compiler. Also you can help us by [reporting bugs](/overviews/contribute/bug-reporting-guide.html).
6+
Issues with the tools, core libraries and compiler. Also you can help us by [reporting bugs](/contribute/bug-reporting-guide.html).

_contribute_resources/3-code-reviews.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Code Reviews
3-
link: /overviews/contribute/codereviews.html
3+
link: /contribute/codereviews.html
44
icon: fa fa-eye
55
---
66
Review pull requests against [scala/scala](https://github.com/scala/scala/pulls),
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Core Libraries
3-
link: /overviews/contribute/corelibs.html
3+
link: /contribute/corelibs.html
44
icon: fa fa-clipboard
55
---
66
Update and expand the capabilities of the core (and associated) Scala libraries.
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: IDE and Build Tools
3-
link: /overviews/contribute/tools.html
3+
link: /contribute/tools.html
44
icon: fa fa-terminal
55
---
66
Enhance the Scala tools with features for build tools, IDE plug-ins and other related projects.
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Compiler/Language
3-
link: /overviews/contribute/guide.html#larger-changes-new-features
3+
link: /contribute/guide.html#larger-changes-new-features
44
icon: fa fa-cogs
55
---
66
Larger language features and compiler enhancements including language specification and SIPs.

_data/doc-nav-header.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
- title: Language Specification
3737
url: http://scala-lang.org/files/archive/spec/2.13/
3838
- title: Contribution Guide
39-
url: "/overviews/contribute/"
39+
url: "/contribute/"
4040
- title: Style Guide
4141
url: "/style/index.html"
4242
- title: Cheatsheet

_data/nav-header.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
url: https://index.scala-lang.org
1212
can-highlight: true
1313
- title: Contribute
14-
url: /overviews/contribute/
14+
url: /contribute/
1515
- title: Blog
1616
url: https://www.scala-lang.org/blog/
1717
can-highlight: true

_overviews/contribute/add-guides.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
---
22
title: Add New Guides/Tutorials
3-
layout: multipage-overview
43
num: 7
5-
partof: scala-contribution
6-
overview-name: Contributing to Scala
74
---
85

96
## Why Contribute New Learning Material?

_overviews/contribute/bug-reporting-guide.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
---
22
title: Bug Reporting Guide
3-
layout: multipage-overview
43
num: 8
5-
partof: scala-contribution
6-
overview-name: Contributing to Scala
74
---
85

96
The Scala compiler and standard library bug tracker is located at [https://github.com/scala/bug](https://github.com/scala/bug), and for Scala 3, it is located at [github.com/lampepfl/dotty](https://github.com/lampepfl/dotty/issues). Before you submit a bug make sure that it is certainly a bug by following instructions in *Is it a Bug?*.

_overviews/contribute/codereviews.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
---
22
title: Code Review Contributions
3-
layout: multipage-overview
43
num: 3
5-
partof: scala-contribution
6-
overview-name: Contributing to Scala
74
---
85
## Code Review Contributions
96

10-
In addition to [bug fixing](/overviews/contribute/guide.html), you can help us review
7+
In addition to [bug fixing](/contribute/guide.html), you can help us review
118
[waiting pull requests](#pull-requests-awaiting-comment).
129
This is also a good (and recommended) way to get to know the feel of
1310
the bug-fixing and submissions process before jumping in with your
@@ -57,4 +54,4 @@ own pull requests.
5754
</div>
5855
</div>
5956

60-
Also note that the [Tools contributions](/overviews/contribute/tools.html) page has more projects that will generate pull requests.
57+
Also note that the [Tools contributions](/contribute/tools.html) page has more projects that will generate pull requests.

_overviews/contribute/corelibs.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
11
---
22
title: Core Library Contributions
3-
layout: multipage-overview
43
num: 4
5-
partof: scala-contribution
6-
overview-name: Contributing to Scala
74
---
85
## Core Library Contributions
96

107
There are several options for contributing to Scala's core libraries. You can:
118

12-
* Help with [Documentation](/overviews/contribute/documentation.html).
13-
* [Report Bugs or Issues](/overviews/contribute/bug-reporting-guide.html) against the core libraries.
14-
* [Fix Bugs or Issues](/overviews/contribute/guide.html) against the
9+
* Help with [Documentation](/contribute/documentation.html).
10+
* [Report Bugs or Issues](/contribute/bug-reporting-guide.html) against the core libraries.
11+
* [Fix Bugs or Issues](/contribute/guide.html) against the
1512
[reported library bugs/issues](https://github.com/scala/bug).
1613

1714
### Significant changes

_overviews/contribute/documentation.md

+5-8
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
---
22
title: Documentation Contributions
3-
layout: multipage-overview
43
num: 5
5-
partof: scala-contribution
6-
overview-name: Contributing to Scala
74
---
85
## Contributing Documentation to the Scala project
96

@@ -23,11 +20,11 @@ Thanks
2320

2421
The Scala API documentation lives with the scala project source code. There are many ways you can help with improving Scaladoc, including:
2522

26-
* [Log issues for missing scaladoc documentation](/overviews/contribute/scala-standard-library-api-documentation.html#contribute-api-documentation-bug-reports) -
23+
* [Log issues for missing scaladoc documentation](/contribute/scala-standard-library-api-documentation.html#contribute-api-documentation-bug-reports) -
2724
Please *follow the issue submission process closely* to help prevent duplicate issues being created.
28-
* [Claim Scaladoc Issues and Provide Documentation](/overviews/contribute/scala-standard-library-api-documentation.html) - please claim issues prior to working on a specific scaladoc task to prevent duplication of effort. If you sit on an issue for too long without submitting a pull request, it will revert back to unassigned and you will need to re-claim it.
25+
* [Claim Scaladoc Issues and Provide Documentation](/contribute/scala-standard-library-api-documentation.html) - please claim issues prior to working on a specific scaladoc task to prevent duplication of effort. If you sit on an issue for too long without submitting a pull request, it will revert back to unassigned and you will need to re-claim it.
2926
* You can also just
30-
[submit new Scaladoc](/overviews/contribute/scala-standard-library-api-documentation.html)
27+
[submit new Scaladoc](/contribute/scala-standard-library-api-documentation.html)
3128
without creating an issue, but please look to see if there is an issue already submitted for your task and claim it if there is. If not, please post your intention to work on a specific scaladoc task on [Scala Contributors](https://contributors.scala-lang.org/) so that people know what you are doing.
3229

3330
### The Main Scala Documentation Site
@@ -44,7 +41,7 @@ without creating an issue, but please look to see if there is an issue already s
4441
* SIP (Scala Improvement Process) Proposals
4542
and more
4643

47-
Please read [Add New Guides/Tutorials](/overviews/contribute/add-guides.html) through before embarking on changes. The site uses
44+
Please read [Add New Guides/Tutorials](/contribute/add-guides.html) through before embarking on changes. The site uses
4845
the [Jekyll](https://jekyllrb.com/) markdown engine so you will need to follow the instructions to get that running as well.
4946

5047
### Updating scala-lang.org
@@ -55,4 +52,4 @@ to Scala and related projects) is provided on the main
5552
[scala-lang GitHub project](https://github.com/scala/scala-lang) which may be forked to create pull requests.
5653

5754
Please read both the
58-
[Add New Guides/Tutorials](/overviews/contribute/add-guides.html) document and the [scala-lang.org GitHub README](https://github.com/scala/scala-lang#scala-langorg) before embarking on any changes to the Scala language site, as it uses the same Jekyll markdown tool and many of the same conventions as the Scala documentation site.
55+
[Add New Guides/Tutorials](/contribute/add-guides.html) document and the [scala-lang.org GitHub README](https://github.com/scala/scala-lang#scala-langorg) before embarking on any changes to the Scala language site, as it uses the same Jekyll markdown tool and many of the same conventions as the Scala documentation site.

_overviews/contribute/guide.md

+14-17
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
---
22
title: Contributing guide
3-
layout: multipage-overview
43
num: 10
5-
partof: scala-contribution
6-
overview-name: Contributing to Scala
74
---
85

96
| **Shortcut** | **Description** |
@@ -41,19 +38,19 @@ unencumbered by copyrights or patents.
4138
4239
This is the impatient developer's checklist for the steps to submit a bug-fix pull request to the Scala project. For more information, description and justification for the steps, follow the links in that step. Further specific instructions for the release of Scala you are targeting can be found in the `CONTRIBUTING.md` file for that [GitHub branch](https://github.com/scala/scala)
4340

44-
1. [Select a bug to fix from GitHub](/overviews/contribute/index.html#community-tickets), or if you found the bug yourself and want to fix it, [create a GitHub issue](/overviews/contribute/bug-reporting-guide.html) (but please
45-
[make sure it's not a duplicate](/overviews/contribute/bug-reporting-guide.html#please-check-before-reporting-a-bug)).
46-
2. Optional ([but recommended](/overviews/contribute/scala-internals.html/#why-its-a-good-idea)), announce your intention to work on the bug on [Scala Contributors](https://contributors.scala-lang.org/). After all, don't you want to work on a team with
47-
[these friendly people](/overviews/contribute/hacker-guide.html#1-connect) - it's one of the perks of contributing.
48-
3. [Fork the Scala repository](/overviews/contribute/hacker-guide.html#fork) and clone your fork (if you haven't already).
49-
4. [Create a feature branch](/overviews/contribute/hacker-guide.html#branch) to work on: use the branch name `issue/NNNN` where NNNN is the GitHub issue number.
50-
5. [Fix the bug, or implement the new small feature](/overviews/contribute/hacker-guide.html#implement), include new tests (yes, for bug fixes too).
51-
6. [Test, rinse](/overviews/contribute/hacker-guide.html#test) and [test some more](/overviews/contribute/partest-guide.html) until [all the tests pass](/overviews/contribute/hacker-guide.html#verify).
52-
7. [Commit your changes](/overviews/contribute/hacker-guide.html#commit) to your feature branch in your fork. Please choose your commit message based on the [Git Hygiene](https://github.com/scala/scala#user-content-git-hygiene) section of the Scala project README.
41+
1. [Select a bug to fix from GitHub](/contribute/index.html#community-tickets), or if you found the bug yourself and want to fix it, [create a GitHub issue](/contribute/bug-reporting-guide.html) (but please
42+
[make sure it's not a duplicate](/contribute/bug-reporting-guide.html#please-check-before-reporting-a-bug)).
43+
2. Optional ([but recommended](/contribute/scala-internals.html/#why-its-a-good-idea)), announce your intention to work on the bug on [Scala Contributors](https://contributors.scala-lang.org/). After all, don't you want to work on a team with
44+
[these friendly people](/contribute/hacker-guide.html#1-connect) - it's one of the perks of contributing.
45+
3. [Fork the Scala repository](/contribute/hacker-guide.html#fork) and clone your fork (if you haven't already).
46+
4. [Create a feature branch](/contribute/hacker-guide.html#branch) to work on: use the branch name `issue/NNNN` where NNNN is the GitHub issue number.
47+
5. [Fix the bug, or implement the new small feature](/contribute/hacker-guide.html#implement), include new tests (yes, for bug fixes too).
48+
6. [Test, rinse](/contribute/hacker-guide.html#test) and [test some more](/contribute/partest-guide.html) until [all the tests pass](/contribute/hacker-guide.html#verify).
49+
7. [Commit your changes](/contribute/hacker-guide.html#commit) to your feature branch in your fork. Please choose your commit message based on the [Git Hygiene](https://github.com/scala/scala#user-content-git-hygiene) section of the Scala project README.
5350
8. If necessary [re-write git history](https://git-scm.com/book/en/Git-Branching-Rebasing) so that [commits are organized by major steps to the fix/feature](
5451
https://github.com/scala/scala#git-hygiene). For bug fixes, a single commit is requested, for features several commits may be desirable (but each separate commit must compile and pass all tests)
55-
9. [Submit a pull request](/overviews/contribute/hacker-guide.html#submit).
56-
10. [Work with a reviewer](https://github.com/scala/scala#reviewing) to [get your pull request merged in](/overviews/contribute/hacker-guide.html#review).
52+
9. [Submit a pull request](/contribute/hacker-guide.html#submit).
53+
10. [Work with a reviewer](https://github.com/scala/scala#reviewing) to [get your pull request merged in](/contribute/hacker-guide.html#review).
5754
11. Celebrate!
5855

5956
Need more information or a little more hand-holding for the first one? We got you covered: take a read through the entire [Hacker Guide][hackers] (or the [equivalent Scala 3 Contributing Guide][scala3-hackers]) for an example of implementing a new feature (some of the steps can be skipped for bug fixes, this will be obvious from reading it, but many of the steps here will help with bug fixes too).
@@ -67,8 +64,8 @@ on the [Scala Contributors](https://contributors.scala-lang.org/) mailing list a
6764
Contributions, big or small, simple or complex, controversial or undisputed, need to materialize as patches against
6865
the Scala project source tree. The hacker's guides ([Scala 2][hackers], or [Scala 3][scala3-hackers]) will explain how to materialize your idea into a full-fledged pull request against the Scala code base.
6966

70-
[hackers]: /overviews/contribute/hacker-guide.html
71-
[community-tickets]: /overviews/contribute/index.html#community-tickets
72-
[bug-reporting-guide]: /overviews/contribute/bug-reporting-guide.html
67+
[hackers]: /contribute/hacker-guide.html
68+
[community-tickets]: /contribute/index.html#community-tickets
69+
[bug-reporting-guide]: /contribute/bug-reporting-guide.html
7370
[scala3-hackers]: {% link _overviews/scala3-contribution/procedures-intro.md %}
7471
[contrib-forum]: https://contributors.scala-lang.org/

_overviews/contribute/hacker-guide.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
---
22
title: Scala hacker guide
33
by: Eugene Burmako
4-
layout: multipage-overview
54
num: 12
6-
partof: scala-contribution
7-
overview-name: Contributing to Scala
85
---
96
<br>
107
This guide is intended to help you get from an idea of fixing a bug or implementing a new feature into a nightly Scala build, and, ultimately, to a production release of Scala incorporating your idea.
@@ -310,7 +307,7 @@ This means your change is backward or forward binary incompatible with the speci
310307

311308
### Verify
312309

313-
Now to make sure that my fix doesn't break anything I need to run the test suite. The Scala test suite uses [JUnit](https://junit.org/junit4/) and [partest](/overviews/contribute/partest-guide.html), a tool we wrote for testing Scala.
310+
Now to make sure that my fix doesn't break anything I need to run the test suite. The Scala test suite uses [JUnit](https://junit.org/junit4/) and [partest](/contribute/partest-guide.html), a tool we wrote for testing Scala.
314311
Run `sbt test` and `sbt partest` to run all of the JUnit and partest tests, respectively.
315312
`partest` (not `sbt partest`) also allows you to run a subset of the tests using wildcards:
316313

_overviews/contribute/inclusive-language-guide.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
---
22
title: Inclusive Language Guide
3-
layout: multipage-overview
43
num: 2
5-
partof: scala-contribution
6-
overview-name: Contributing to Scala
74
---
85

96
We are committed to providing a friendly, safe and welcoming environment for

_overviews/contribute/index.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
---
22
title: Contribute
3-
layout: multipage-overview
43
num: 1
5-
partof: scala-contribution
6-
overview-name: Contributing to Scala
74
---
85

96
The Scala programming language is an open source project with a very
@@ -18,7 +15,7 @@ That depends on what you want to contribute. Below are some getting started reso
1815

1916
### Reporting bugs
2017

21-
See our [bug reporting guide](/overviews/contribute/bug-reporting-guide.html) to learn
18+
See our [bug reporting guide](/contribute/bug-reporting-guide.html) to learn
2219
how to efficiently report a bug.
2320

2421
### Contribute
@@ -33,7 +30,7 @@ Coordination of contribution efforts takes place on
3330
When contributing, please follow:
3431

3532
* The [Scala Code of Conduct](https://scala-lang.org/conduct/)
36-
* The [Inclusive Language Guide](/overviews/contribute/inclusive-language-guide.html)
33+
* The [Inclusive Language Guide](/contribute/inclusive-language-guide.html)
3734

3835
### Community Tickets
3936

_overviews/contribute/partest-guide.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
---
22
title: Running the Test Suite
3-
layout: multipage-overview
43
num: 13
5-
partof: scala-contribution
6-
overview-name: Contributing to Scala
74
---
85

96
Partest is a custom parallel testing tool that we use to run the test suite for the Scala compiler and library. Go to the scala project folder from your local checkout and run it via `sbt`, `ant` or standalone as follows.

_overviews/contribute/scala-internals.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
---
22
title: Scala Contributors Forum
3-
layout: multipage-overview
43
num: 9
5-
partof: scala-contribution
6-
overview-name: Contributing to Scala
74
---
85

96
The [Scala Contributors Forum][scala-contributors] is where discussions about the Scala ecosystem

_overviews/contribute/scala-standard-library-api-documentation.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
---
22
title: Contribute to API Documentation
3-
layout: multipage-overview
43
num: 6
5-
partof: scala-contribution
6-
overview-name: Contributing to Scala
74
---
85

96
This page is specific to API documentation contributions – that is, API
@@ -13,7 +10,7 @@ sometimes referred to as Scaladoc contributions.
1310

1411
For contributions to tutorial and guide-style documentation on
1512
[docs.scala-lang.org](/),
16-
see [Add New Guides/Tutorials](/overviews/contribute/add-guides.html).
13+
see [Add New Guides/Tutorials](/contribute/add-guides.html).
1714

1815
*Please note, these instructions cover documentation contributions Scala core
1916
libraries only. For other Scala projects please check those projects for the
@@ -79,7 +76,7 @@ component so that they show up in the correct issue filters.
7976
Please familiarize yourself with the following before contributing
8077
new API documentation to save time, effort, mistakes and repetition.
8178

82-
* [Forking the Repo](/overviews/contribute/hacker-guide.html#2-set-up) - follow the setup steps through
79+
* [Forking the Repo](/contribute/hacker-guide.html#2-set-up) - follow the setup steps through
8380
the Branch section. If providing new documentation related to an existing GitHub issue, use `issue/NNNN`
8481
or `ticket/NNNN` as the guide states. If providing API documentation with no associated
8582
GitHub issue, use `scaladoc/xxxx` instead.

0 commit comments

Comments
 (0)