Skip to content

Commit

Permalink
Checked and fixed some issues in docs. (#502)
Browse files Browse the repository at this point in the history
Co-authored-by: Derk-Jan Karrenbeld <[email protected]>
  • Loading branch information
MahdiDavoodi and SleeplessByte authored Oct 22, 2021
1 parent 84fb96b commit 42e2f57
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 29 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Source for Exercism Exercises in Kotlin.

## Contributing Guide

For general information about how to contribute to Exercism, please refer to the [contributing guide](https://github.com/exercism/docs/blob/master/contributing-to-language-tracks/README.md).
For general information about how to contribute to Exercism, please refer to the [contributing guide](https://exercism.org/docs/building).

## Table of Contents

Expand All @@ -33,10 +33,10 @@ To submit a fix for an existing exercise or port an exercise to Kotlin with the

1. **Ensure you have the basic Java tooling installed:** JDK 1.8+, an editor and Gradle 2.x.

(see [exercism.io: Installing Kotlin](http://exercism.io/languages/kotlin/installation))
(see [exercism.io: Installing Kotlin](https://exercism.org/docs/tracks/kotlin/installation))
- **Setup a branch on a fork of [exercism/kotlin](https://github.com/exercism/kotlin) on your computer.**

Use those instructions (in conjunction with the [Git Basics doc](https://github.com/exercism/docs/blob/master/contributing/git-basics.md)) to:
Next steps:
* "fork" a repository on GitHub;
- install `git`;
- "clone" a copy of your fork;
Expand All @@ -54,7 +54,8 @@ Use those instructions (in conjunction with the [Git Basics doc](https://github.
$ git push
```

The Git Basics doc has a section on [commit messages](https://github.com/exercism/docs/blob/master/contributing/git-basics.md#commit-messages) that provides practical advice on crafting meaningful commit messages.
It is advised you write meaningful commit messages. [Chris Beams wrote about "How to Write a Git Commit Message"](https://chris.beams.io/posts/git-commit/).

- **Verify that your work passes all tests.** When you create a pull request (PR), GitHub triggers a build on Travis CI. Your PR will not be merged unless those tests pass.

## Getting Familiar With the Codebase
Expand Down
14 changes: 7 additions & 7 deletions docs/INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ We recommend closing the administrative command prompt and opening a new command

You now are ready to get started with the Kotlin track of Exercism!

To get started, see "[Running the Tests](http://exercism.io/languages/kotlin/tests)".
To get started, see "[Running the Tests](https://exercism.org/docs/tracks/kotlin/tests)".

----

Expand Down Expand Up @@ -71,7 +71,7 @@ Below are instructions for install using the most common method - using Homebrew

You now are ready to get started with the Kotlin track of Exercism!

To get started, see "[Running the Tests](http://exercism.io/languages/kotlin/tests)".
To get started, see "[Running the Tests](https://exercism.org/docs/tracks/kotlin/tests)".

----

Expand Down Expand Up @@ -101,7 +101,7 @@ If you are using Debian or its derivatives (like Ubuntu or Linux Mint), use APT:
You now are ready to get started with the Kotlin track of Exercism!
To get started, see "[Running the Tests](http://exercism.io/languages/kotlin/tests)".
To get started, see "[Running the Tests](https://exercism.org/docs/tracks/kotlin/tests)".
----
Expand All @@ -122,7 +122,7 @@ which lets you install OpenJdk11 with ease. Use the following steps:

You now are ready to get started with the Kotlin track of Exercism!

To get started, see "[Running the Tests](http://exercism.io/languages/kotlin/tests)".
To get started, see "[Running the Tests](https://exercism.org/docs/tracks/kotlin/tests)".

----

Expand All @@ -144,7 +144,7 @@ To get started, see "[Running the Tests](http://exercism.io/languages/kotlin/tes
You now are ready to get started with the Kotlin track of Exercism!
To get started, see "[Running the Tests](http://exercism.io/languages/kotlin/tests)".
To get started, see "[Running the Tests](https://exercism.org/docs/tracks/kotlin/tests)".
----
Expand All @@ -158,7 +158,7 @@ To get started, see "[Running the Tests](http://exercism.io/languages/kotlin/tes
You now are ready to get started with the Kotlin track of Exercism!
To get started, see "[Running the Tests](http://exercism.io/languages/kotlin/tests)".
To get started, see "[Running the Tests](https://exercism.org/docs/tracks/kotlin/tests)".
----
Expand All @@ -172,7 +172,7 @@ To get started, see "[Running the Tests](http://exercism.io/languages/kotlin/tes
You now are ready to get started with the Kotlin track of Exercism!
To get started, see "[Running the Tests](http://exercism.io/languages/kotlin/tests)".
To get started, see "[Running the Tests](https://exercism.org/docs/tracks/kotlin/tests)".
----
Expand Down
10 changes: 5 additions & 5 deletions docs/LEARNING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Recommended learning resources

* [Kotlin Tutorials](https://kotlinlang.org/docs/tutorials/)
* [Kotlin Documentation](https://kotlinlang.org/docs/reference/)
* [Kotlin Idioms](https://kotlinlang.org/docs/reference/idioms.html)
* [Get started with Kotlin](https://kotlinlang.org/docs/getting-started.html)
* [Kotlin Documentation](https://kotlinlang.org/docs/home.html)
* [Kotlin Idioms](https://kotlinlang.org/docs/idioms.html)
* [Kotlin Tutorial Videos](https://kotlinlang.org/docs/videos.html)
* [Stack Overflow](https://stackoverflow.com/questions/tagged/kotlin)

* [Kotlin examples](https://play.kotlinlang.org/byExample/overview)
* [Kotlin on Stack Overflow](https://stackoverflow.com/questions/tagged/kotlin)
12 changes: 6 additions & 6 deletions docs/TESTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,12 @@ Choose your operating system:
```
*(Don't worry about the tests failing, at first, this is how you begin each exercise.)*

5. Solve the exercise. Find and work through the `TUTORIAL.md` guide ([view on GitHub](https://github.com/exercism/kotlin/blob/master/exercises/hello-world/TUTORIAL.md)).
5. Solve the exercise. Find and work through the `TUTORIAL.md` guide ([view on GitHub](https://github.com/exercism/kotlin/blob/main/exercises/practice/hello-world/TUTORIAL.md)).


Good luck! Have fun!

If you get stuck, at any point, don't forget to reach out for [help](http://exercism.io/languages/kotlin/help).
If you get stuck, at any point, don't forget to reach out for [help](https://exercism.org/docs/using/contact).

----

Expand Down Expand Up @@ -73,11 +73,11 @@ If you get stuck, at any point, don't forget to reach out for [help](http://exer
```
*(Don't worry about the tests failing, at first, this is how you begin each exercise.)*

4. Solve the exercise. Find and work through the `TUTORIAL.md` guide ([view on GitHub](https://github.com/exercism/kotlin/blob/master/exercises/hello-world/TUTORIAL.md)).
4. Solve the exercise. Find and work through the `TUTORIAL.md` guide ([view on GitHub](https://github.com/exercism/kotlin/blob/main/exercises/practice/hello-world/TUTORIAL.md)).

Good luck! Have fun!

If you get stuck, at any point, don't forget to reach out for [help](http://exercism.io/languages/kotlin/help).
If you get stuck, at any point, don't forget to reach out for [help](https://exercism.org/docs/using/contact).

----

Expand Down Expand Up @@ -107,9 +107,9 @@ If you get stuck, at any point, don't forget to reach out for [help](http://exer
```
*(Don't worry about the tests failing, at first, this is how you begin each exercise.)*

4. Solve the exercise. Find and work through the `TUTORIAL.md` guide ([view on GitHub](https://github.com/exercism/kotlin/blob/master/exercises/hello-world/TUTORIAL.md)).
4. Solve the exercise. Find and work through the `TUTORIAL.md` guide ([view on GitHub](https://github.com/exercism/kotlin/blob/main/exercises/practice/hello-world/TUTORIAL.md)).

Good luck! Have fun!

If you get stuck, at any point, don't forget to reach out for [help](http://exercism.io/languages/kotlin/help).
If you get stuck, at any point, don't forget to reach out for [help](https://exercism.org/docs/using/contact).

14 changes: 7 additions & 7 deletions exercises/practice/hello-world/TUTORIAL.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Tutorial

NOTE: You can also view the HTML version of this file here:
https://github.com/exercism/kotlin/blob/master/exercises/hello-world/TUTORIAL.md
<https://github.com/exercism/kotlin/blob/main/exercises/practice/hello-world/TUTORIAL.md>

* [Introduction](#introduction)
* [Exercise Structure](#exercise-structure)
Expand All @@ -21,11 +21,11 @@ Each exercise comes with a set of tests. The first pass through the
exercise is about getting all of the tests to pass, one at a time.

If you have not installed the Java Development Kit and Gradle, you must do
so now. For help with this, see: http://exercism.io/languages/kotlin/installation
so now. For help with this, see: https://exercism.org/docs/tracks/kotlin/installation

----

This guide picks-up where [Running the Tests (in Kotlin)](http://exercism.io/languages/kotlin/tests)
This guide picks-up where [Running the Tests (in Kotlin)](https://exercism.org/docs/tracks/kotlin/tests)
left off. If you haven't reviewed those instructions, do so now.

The following instructions work equally well on Windows, macOS and Linux.
Expand Down Expand Up @@ -225,7 +225,7 @@ From here, there are a number of paths you can take.
## Move on to another exercise

There are many more exercises you can practice with. Grab another one
from the [Kotlin track](https://exercism.io/my/tracks/kotlin).
from the [Kotlin track](https://exercism.org/tracks/kotlin).


## Review (and comment on) others' submissions to this exercise
Expand All @@ -245,7 +245,7 @@ because you'll have your own experience of trying to solve the problem.

Here's an up-to-date list of submissions on the Kotlin track:

http://exercism.io/tracks/kotlin/exercises
<https://exercism.org/tracks/kotlin/exercises>



Expand Down Expand Up @@ -276,14 +276,14 @@ than 100 maintainers and many more contributors.

A starting point to jumping in can be found here:

https://github.com/exercism/docs/blob/master/contributing-to-language-tracks/README.md
<https://exercism.org/docs/building>

----

Regardless of what you decide to do next, we sincerely hope you learn
and enjoy being part of this community. If at any time you need assistance
do not hesitate to ask for help:

http://exercism.io/languages/kotlin/help
<https://exercism.org/docs/using/contact>

Cheers!

0 comments on commit 42e2f57

Please sign in to comment.