Skip to content

Commit 0cb4cf7

Browse files
committed
Get rid of some of the permalinks that are breaking everything
1 parent ccdc853 commit 0cb4cf7

11 files changed

+48
-49
lines changed

contribute/bug-reporting-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Bug Reporting
33
layout: inner-page-no-masthead
4-
permalink: /contribute/bug-reporting-guide/
4+
# permalink: /contribute/bug-reporting-guide/
55
includeTOC: true
66
---
77

contribute/codereviews.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
22
title: Code Review Contributions
33
layout: inner-page-no-masthead
4-
permalink: /contribute/codereviews/
4+
# permalink: /contribute/codereviews/
55
includeTOC: true
66
---
77
## Code Review Contributions
88

9-
In addition to [bug fixing](/contribute/guide/), you can help us review
10-
[waiting pull requests](#pull-requests-awaiting-comment).
9+
In addition to [bug fixing](/contribute/guide/), you can help us review
10+
[waiting pull requests](#pull-requests-awaiting-comment).
1111
This is also a good (and recommended) way to get to know the feel of
1212
the bug-fixing and submissions process before jumping in with your
1313
own pull requests.
1414

15-
15+
1616
### Review Guidelines
1717

1818
[Code of Conduct reminder](/conduct/)

contribute/corelibs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Core Library Contributions
33
layout: inner-page-no-masthead
4-
permalink: /contribute/corelibs/
4+
# permalink: /contribute/corelibs/
55
includeTOC: true
66
---
77
## Core Library Contributions
@@ -10,14 +10,14 @@ There are several options for contributing to Scala's core libraries. You can:
1010

1111
* Help with [Documentation](/contribute/scala-standard-library-api-documentation/).
1212
* [Report Bugs or Issues](/contribute/bug-reporting-guide/) against the core libraries.
13-
* [Fix Bugs or Issues](/contribute/guide/) against the
13+
* [Fix Bugs or Issues](/contribute/guide/) against the
1414
[reported library bugs/issues](https://issues.scala-lang.org/issues/?filter=13001).
1515
* Contribute significant new functionality or a new API by submitting
1616
a Scala Library Improvement Process (SLIP) Document.
1717

1818
### Submitting a SLIP
1919

20-
For significant new functionality or a whole new API to be considered for
20+
For significant new functionality or a whole new API to be considered for
2121
inclusion in the core Scala distribution, you will be asked to submit a SLIP (Scala Library Improvement Process) document.
2222

2323
Please see [instructions for submitting a new SLIP](http://docs.scala-lang.org/sips/slip-submission.html) and familiarize yourself with the [SIP/SLIP](http://docs.scala-lang.org/sips/) section of the Scala documentation site. Also please pay particular attention to the [pre-requisites](http://docs.scala-lang.org/sips/slip-submission.html) before submitting a SLIP.

contribute/documentation.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Documentation Contributions
33
layout: inner-page-no-masthead
4-
permalink: /contribute/documentation/
4+
# permalink: /contribute/documentation/
55
includeTOC: true
66
---
77
## Contributing Documentation to the Scala project
@@ -14,20 +14,20 @@ There are several ways you can help out with the improvement of Scala documentat
1414

1515
Please read this page, and the pages linked from this one, fully before contributing documentation. Many of the questions you have will be answered in these resources. If you have a question that isn't answered, feel free to ask on the [scala-internals Google group](https://groups.google.com/forum/#!forum/scala-internals) and then, please, submit a pull request with updated documentation reflecting that answer.
1616

17-
**General requirements** for documentation submissions include spell-checking all written language, ensuring code samples compile and run correctly, correct grammar, and clean formatting/layout of the documentation.
17+
**General requirements** for documentation submissions include spell-checking all written language, ensuring code samples compile and run correctly, correct grammar, and clean formatting/layout of the documentation.
1818

1919
Thanks
2020

2121
### API Documentation (Scaladoc)
2222

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

25-
* [Log issues for missing scaladoc documentation](/contribute/scala-standard-library-api-documentation/#contribute-api-documentation-bug-reports) -
25+
* [Log issues for missing scaladoc documentation](/contribute/scala-standard-library-api-documentation/#contribute-api-documentation-bug-reports) -
2626
Please *follow the issue submission process closely* to help prevent duplicate issues being created.
2727
* [Claim Scaladoc Issues and Provide Documentation](/contribute/scala-standard-library-api-documentation/) - 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.
28-
* You can also just
29-
[submit new Scaladoc](/contribute/scala-standard-library-api-documentation/)
30-
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-internals so that people know what you are doing.
28+
* You can also just
29+
[submit new Scaladoc](/contribute/scala-standard-library-api-documentation/)
30+
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-internals so that people know what you are doing.
3131

3232
### The Main Scala Documentation Site
3333

@@ -43,15 +43,15 @@ without creating an issue, but please look to see if there is an issue already s
4343
* SIP (Scala Improvement Process) Proposals
4444
and more
4545

46-
Please read [contributing to the docs.scala-lang.org site](http://docs.scala-lang.org/contribute.html) through before embarking on changes. The site uses
46+
Please read [contributing to the docs.scala-lang.org site](http://docs.scala-lang.org/contribute.html) through before embarking on changes. The site uses
4747
the [Jekyll](http://jekyllrb.com/) markdown engine so you will need to follow the instructions to get that running as well.
4848

4949
### Updating scala-lang.org
5050

5151
Additional high-level documentation (including documentation on contributing
52-
to Scala and related projects) is provided on the main
53-
[Scala Language site](http://scala-lang.org), and is also kept in the
54-
[scala-lang github project](https://github.com/scala/scala-lang) which may be forked to create pull requests.
52+
to Scala and related projects) is provided on the main
53+
[Scala Language site](http://scala-lang.org), and is also kept in the
54+
[scala-lang github project](https://github.com/scala/scala-lang) which may be forked to create pull requests.
5555

5656
Please read both the
5757
[docs.scala-lang.org contribution](http://docs.scala-lang.org/contribute.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.

contribute/guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Contributing guide
33
layout: inner-page-no-masthead
4-
permalink: /contribute/guide/
4+
# permalink: /contribute/guide/
55
includeTOC: true
66
---
77

@@ -54,9 +54,9 @@ unencumbered by copyrights or patents.
5454

5555
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)
5656

57-
1. [Select a bug to fix from JIRA](/contribute/#community-tickets), or if you found the bug yourself and want to fix it, [create a JIRA issue](/contribute/bug-reporting-guide/) (but please
57+
1. [Select a bug to fix from JIRA](/contribute/#community-tickets), or if you found the bug yourself and want to fix it, [create a JIRA issue](/contribute/bug-reporting-guide/) (but please
5858
[make sure it's not a duplicate](/contribute/bug-reporting-guide/#reporting-confirmed-bugs-is-a-sin)).
59-
2. Optional ([but recommended](/contribute/scala-internals/#why-its-a-good-idea)), announce your intention to work on the bug on [scala-internals](/contribute/scala-internals/). After all, don't you want to work on a team with
59+
2. Optional ([but recommended](/contribute/scala-internals/#why-its-a-good-idea)), announce your intention to work on the bug on [scala-internals](/contribute/scala-internals/). After all, don't you want to work on a team with
6060
[these friendly people](/contribute/hacker-guide/#connect) - it's one of the perks of contributing.
6161
3. [Fork the Scala repository](/contribute/hacker-guide/#fork) and clone your fork (if you haven't already).
6262
4. [Create a feature branch](/contribute/hacker-guide/#branch) to work on: use the branch name `issue/NNNN` where NNNN is the JIRA issue number.

contribute/hacker-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Scala hacker guide
33
by: Eugene Burmako
44
layout: inner-page-no-masthead
5-
permalink: /contribute/hacker-guide/
5+
# permalink: /contribute/hacker-guide/
66
includeTOC: true
77
---
88
<br>
@@ -54,7 +54,7 @@ it probably makes sense to familiarize yourself with Git first. We recommend
5454

5555
* the [Git Pro](http://git-scm.com/book/en/) online book.
5656
* the help page on [Forking a Git Repository](https://help.github.com/articles/fork-a-repo).
57-
* this great training tool [LearnGitBranching](http://pcottle.github.io/learnGitBranching/). One hour hands-on training helps more than 1000 hours reading.
57+
* this great training tool [LearnGitBranching](http://pcottle.github.io/learnGitBranching/). One hour hands-on training helps more than 1000 hours reading.
5858

5959
### Fork
6060

contribute/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Contribute
33
layout: inner-page-no-masthead
4-
permalink: /contribute/
4+
# permalink: /contribute/
55
includeTOC: true
66
---
77

@@ -22,7 +22,7 @@ how to efficiently report a bug.
2222

2323
### Contribute
2424

25-
Coordination of contribution efforts takes place on the
25+
Coordination of contribution efforts takes place on the
2626
[scala-internals Google group](/contribute/scala-internals/).
2727

2828
{% include column-list-of-items.html collection=site.contribute_resources %}

contribute/partest-guide.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Running the Test Suite
33
layout: inner-page-no-masthead
4-
permalink: /contribute/partest-guide/
4+
# permalink: /contribute/partest-guide/
55
includeTOC: true
66
---
77

@@ -14,11 +14,11 @@ The test suite can be run by using ant from the command line:
1414
$ ant test.suite
1515

1616
## Standalone
17-
18-
There are launch scripts `partest` and `partest.bat` in the `test` folder of the scala project. To have partest run failing tests only and print details about test failures to the console, you can use
19-
17+
18+
There are launch scripts `partest` and `partest.bat` in the `test` folder of the scala project. To have partest run failing tests only and print details about test failures to the console, you can use
19+
2020
./test/partest --show-diff --show-log --failed
21-
21+
2222
You can get a summary of the usage by running partest without arguments.
2323

2424
* Most commonly you want to invoke partest with an option that tells it which part of the tests to run. For example `--all`, `--pos`, `--neg` or `--run`.
@@ -29,13 +29,13 @@ You can get a summary of the usage by running partest without arguments.
2929
* You can use the `SCALAC_OPTS` environment variable to pass command line options to the compiler.
3030
* You can use the `JAVA_OPTS` environment variable to pass command line options to the runner (e.g., for `run/jvm` tests).
3131
* The launch scripts run partest as follows:
32-
32+
3333
scala -cp <path to partest classes> scala.tools.partest.nest.NestRunner <options>
34-
34+
3535
Partest classes from a `quick` build, e.g., can be found in `./build/quick/classes/partest/`.
36-
36+
3737
Partest will tell you where it loads compiler/library classes from by adding the `partest.debug` property:
38-
38+
3939
scala -Dpartest.debug=true -cp <path to partest classes> scala.tools.partest.nest.NestRunner <options>
4040

4141

@@ -46,10 +46,10 @@ Tests that depend on [ScalaCheck](https://github.com/rickynils/scalacheck) can b
4646

4747
import org.scalacheck._
4848
import Prop._
49-
49+
5050
object Test {
5151
val prop_ConcatLists = property{ (l1: ListInt, l2: ListInt) =>
52-
l1.size + l2.size == (l1 ::: l2).size
52+
l1.size + l2.size == (l1 ::: l2).size
5353
}
5454

5555
val tests = List(("prop_ConcatLists", prop_ConcatLists))
@@ -59,10 +59,10 @@ Tests that depend on [ScalaCheck](https://github.com/rickynils/scalacheck) can b
5959

6060
### Windows
6161

62-
Some tests might fail because line endings in the `.check` files and the produced results do not match. In that case, set either
62+
Some tests might fail because line endings in the `.check` files and the produced results do not match. In that case, set either
6363

64-
git config core.autocrlf false
64+
git config core.autocrlf false
6565

66-
or
66+
or
6767

68-
git config core.autocrlf input
68+
git config core.autocrlf input

contribute/scala-internals.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ includeTOC: true
77

88
## scala-internals
99

10-
The [scala-internals mailing list](https://groups.google.com/d/forum/scala-internals) is where technical and logistical discussions concerning bugs, bug fixes, documentation, improvements, new features and other contributor related topics occur.
10+
The [scala-internals mailing list](https://groups.google.com/d/forum/scala-internals) is where technical and logistical discussions concerning bugs, bug fixes, documentation, improvements, new features and other contributor related topics occur.
1111

1212
### Coordinating on scala-internals
1313

14-
Prior to commencing on contribution work on larger changes to the Scala project, it is recommended (but not required) that you make a post on scala-internals announcing your intention. It's a great time to invite any help, advice or ask any questions you might have. It's also a great place to meet peers, one of whom will probably be reviewing your contribution at some point. For smaller bug fixes or documentation changes where the risk of effort duplication is minimal, you can skip this post.
14+
Prior to commencing on contribution work on larger changes to the Scala project, it is recommended (but not required) that you make a post on scala-internals announcing your intention. It's a great time to invite any help, advice or ask any questions you might have. It's also a great place to meet peers, one of whom will probably be reviewing your contribution at some point. For smaller bug fixes or documentation changes where the risk of effort duplication is minimal, you can skip this post.
1515

1616
To help subscribers on the scala-internals list to sort through the postings, we request that the following topic labels are applied when you start a new post please:
1717

@@ -44,4 +44,3 @@ While it is optional to announce your intentions/work items on scala-internals b
4444
* There are a lot of nice people waiting to talk to you on scala-internals, you might be surprised how valuable and pleasant you find the experience of talking to them.
4545

4646
If all of this has not convinced you then, please, go ahead and work on contributions anyway. It *is* less important to post to scala-internals first for small, self contained bugs than it is for larger issues or features, and not having posted first will not be a reason for your PR to be rejected, it just might be a rougher review/merge process than if you had posted first. It's your choice.
47-

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Contribute to API Documentation
33
layout: inner-page-no-masthead
4-
permalink: /contribute/scala-standard-library-api-documentation/
4+
# permalink: /contribute/scala-standard-library-api-documentation/
55
includeTOC: true
66
---
77

contribute/tools.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: IDE and Build Tool Contributions
33
layout: inner-page-no-masthead
4-
permalink: /contribute/tools/
4+
# permalink: /contribute/tools/
55
includeTOC: true
66

77
# Projects list:
@@ -45,7 +45,7 @@ projects:
4545
homeLink: http://docs.scala-lang.org/tutorials/partest-guide.html
4646
issuesLink: https://github.com/scala/scala-partest/issues
4747
readmeLink: https://github.com/scala/scala-partest/blob/master/README.md
48-
contributingLink:
48+
contributingLink:
4949
- title: Ensime
5050
description: Scala Support for Text Editors
5151
icon: https://avatars0.githubusercontent.com/u/5089042?v=3&s=200
@@ -76,7 +76,7 @@ projectsInNeed:
7676
description: Scala Decoder (part of scala/scala)
7777
icon: https://avatars1.githubusercontent.com/u/57059?v=3&s=200
7878
link: https://github.com/scala/scala
79-
homeLink:
79+
homeLink:
8080
issuesLink: https://issues.scala-lang.org/issues/?jql=status%20%3D%20Open%20AND%20text%20~%20%22scalap%22
8181
readmeLink: https://github.com/scala/scala#welcome
8282
contributingLink: https://github.com/sbt/sbt/blob/0.13/CONTRIBUTING.md
@@ -103,7 +103,7 @@ if you would like to help revive them.
103103

104104
### Broken Links?
105105

106-
Stuff changes. Found a broken link or something that needs updating on this page? Please, consider [submitting a documentation pull request](/contribute/documentation/#updating-scala-langorg) to fix it.
106+
Stuff changes. Found a broken link or something that needs updating on this page? Please, consider [submitting a documentation pull request](/contribute/documentation/#updating-scala-langorg) to fix it.
107107

108108
### Projects
109109

@@ -113,4 +113,4 @@ Stuff changes. Found a broken link or something that needs updating on this page
113113

114114
The following projects are important to the Scala community but are particularly in need of contributors to continue their development.
115115

116-
{% include contributions-projects-list.html collection=page.projectsInNeed %}
116+
{% include contributions-projects-list.html collection=page.projectsInNeed %}

0 commit comments

Comments
 (0)