Skip to content

Commit 9839c84

Browse files
committed
Format markdown according to new spec
1 parent 73f68c1 commit 9839c84

26 files changed

+156
-111
lines changed

licences/cc_sa_4.md renamed to licences/cc_sa_4.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Attribution-ShareAlike 4.0 International
1+
ittribution-ShareAlike 4.0 International
22

33
=======================================================================
44

licences/mit.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# MIT Licence
2+
13
Copyright 2019 Exercism
24

35
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

pages/about.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
### What is Exercism?
1+
# About Exercism
2+
## What is Exercism?
23

34
Exercism is an online platform designed to help you improve your coding skills through practice and mentorship.
45

@@ -12,6 +13,6 @@ Exercism is designed to be fun and friendly, and we place a strong emphasis on e
1213

1314
Sign up and have fun. Exercism is 100% free :)
1415

15-
### Who owns and runs Exercism?
16+
## Who owns and runs Exercism?
1617

1718
Exercism is a not-for-profit company. It is legally based in the United Kingdom, with Company Registration Number [11733062](https://beta.companieshouse.gov.uk/company/11733062). It is "company limited by guarantee" which means there are no shareholders, and no individuals "own" the company. Instead, the company has trustees who are responsible for ensuring it meets its aims and objectives. The current trustees are Katrina Owen and Jeremy Walker, who are also the company's Directors.

pages/about_v1_to_v2.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1+
# About v1 to v2 transition
2+
13
We've rebuilt Exercism from the ground up to provide a smoother, more in-depth experience. Exercism now has progression through tracks, more structured mentoring and a much better user interface.
24

35
Below, we have outlined a few of the biggest changes. For even **more** details you can view [this document](https://github.com/exercism/v2-feedback). If you need help migrating solutions on your local system from v1 to v2, please [read this document](/cli-v1-to-v2).
46

57
We are still working through lots of TODOs to get things right, so please bear with us, but we hope you find this new version more fun and useful than ever.
68

7-
### New branding
9+
## New branding
810

911
There are aspects of the old logo and branding that we like, but we found that it doesn't express the most important thing about Exercism: this is a friendly, welcoming place focused on the humans.
1012

@@ -16,7 +18,7 @@ We want to emphasize human connections and a supportive, friendly learning envir
1618

1719
To this end we have designed a completely new logo, and a new design aesthetic.
1820

19-
### Redesigned language tracks
21+
## Redesigned language tracks
2022

2123
We have completely redesigned the experience around joining, participating in, and completing a language track.
2224

@@ -49,7 +51,7 @@ Notice that we're not focusing on "artisans" as a core audience for the exercise
4951

5052
That said, we believe that Exercism has a lot to offer artisans, and they are part of our core "mentor" audience, described in more detail below.
5153

52-
### A new mentorship model
54+
## A new mentorship model
5355
Because learning can be such a vulnerable process, we decided after much deliberation to make the mentorship process private between the learner and their mentors. There are some giant trade-offs inherent in this choice, between helping people feel safe and supported, scaling mentorship, and making solutions available for others to learn from. We will be addressing some aspects of the old model of communal feedback and learning with the new teams interface.
5456

5557
We have written in depth about the considerations we wrestled with and that led to this decision in the design document about code review.
@@ -62,7 +64,7 @@ In order to reduce the risk of learners feeling like they're at the bottom of a
6264

6365
Once a student has completed an exercise, they can decide whether or not to make it available to the broader Exercism community. If someone decides to make the solution available, they can also decide whether or not to include it in their public showcase.
6466

65-
### Privacy features
67+
## Privacy features
6668
**Aliases:** People can choose on a track-by-track basis what avatar they want to use and what handle they want to go by. This means that people can use their Exercism username publicly in some tracks while remaining private in others. Logging in is now decoupled from GitHub, so the Exercism username may or may not be the same as their GitHub username. If someone chooses to use a handle that is different from their username, then we will make it clear to mentors that this is an alias.
6769

6870
**Blocking:** People can choose to not interact with certain others. This goes for both learners who can opt out of certain mentors, and mentors who can choose to not work with certain learners. There are a number of reasons why people might want to not interact with someone, and they do not all reflect poorly on the person in question. We will however, be monitoring this data for outliers so that we can intervene if we are seeing behavior that is concerning.

pages/automated_solution_analysis.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
### What is it?
1+
# Autoamted Solution Analysis
2+
## What is it?
23

34
We algorithmically analyse solutions to certain exercises to look for optimal solutions, which we can then instantly approve allowing students to move on to the next exercise without delay.
45

5-
### How does it work?
6+
## How does it work?
67

78
We use a mixture of techniques to analyze solutions, but most centre around statically analysing the code that students submit. Each language has a different analyzer maintained by a different team, who may approach things in different ways. You may be interested in browsing the code to see how this works:
89
- [C#](https://github.com/exercism/csharp-analyzer)

pages/become_a_maintainer.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
1-
[tracks]: https://exercism.io/tracks
2-
[repositories]: https://github.com/exercism
3-
[triaging-issues]: https://github.com/exercism/docs/blob/master/you-can-help/triage-issues.md
4-
[reviewing-prs]: https://github.com/exercism/docs/blob/master/you-can-help/review-pull-requests.md
5-
[porting]: https://github.com/exercism/docs/blob/master/you-can-help/implement-an-exercise-from-specification.md
6-
[problem-specifications]: https://github.com/exercism/problem-specifications
7-
[blazon]: https://github.com/exercism/blazon
8-
[blazon-process]: https://github.com/exercism/docs/blob/master/you-can-help/improve-exercise-metadata.md
9-
[fixing-readmes]: https://github.com/exercism/docs/blob/master/language-tracks/exercises/anatomy/readmes.md
1+
# Become a maintainer
102

113
The Exercism language tracks are a great way to get involved in:
124

@@ -148,3 +140,13 @@ hard to figure out how to solve it anyway.
148140
In this case consider whether there's a blog post or some documentation that
149141
you could point people to, and add it to `$ROOT/exercises/$SLUG/.meta/hints.md` in the exercise directory
150142
in the language track. If the file doesn't exist, create a new one.
143+
144+
[tracks]: https://exercism.io/tracks
145+
[repositories]: https://github.com/exercism
146+
[triaging-issues]: https://github.com/exercism/docs/blob/master/you-can-help/triage-issues.md
147+
[reviewing-prs]: https://github.com/exercism/docs/blob/master/you-can-help/review-pull-requests.md
148+
[porting]: https://github.com/exercism/docs/blob/master/you-can-help/implement-an-exercise-from-specification.md
149+
[problem-specifications]: https://github.com/exercism/problem-specifications
150+
[blazon]: https://github.com/exercism/blazon
151+
[blazon-process]: https://github.com/exercism/docs/blob/master/you-can-help/improve-exercise-metadata.md
152+
[fixing-readmes]: https://github.com/exercism/docs/blob/master/language-tracks/exercises/anatomy/readmes.md

pages/changelog.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,55 @@
1-
### [Website]- Add ability to change which solutions are published:
1+
# Changelog
2+
3+
## [Website]- Add ability to change which solutions are published:
24

35
Previously, you could not change which solutions are published. We have now enabled this along with the ability to choose which appear on the profile and which allow public comments. [#4163](https://github.com/exercism/exercism/issues/4163)
46

5-
### [Website] Add communal mentoring notes
7+
## [Website] Add communal mentoring notes
68
We have exposed the communal mentoring notes from GitHub to be visible directly within the UI.
79

8-
### [Teams] Launch the site
10+
## [Teams] Launch the site
911

1012
We have built a dedicated site for teams. It allows groups of people to complete exercises and mentor each other in a private space. We envision it being used by bootcamps, groups of friends, and colleagues at work.
1113

12-
### [Website] Delete my account
14+
## [Website] Delete my account
1315

1416
We needed to give people the ability to delete their account without emailing Jeremy.
1517

16-
### [Website] Reset CLI token
18+
## [Website] Reset CLI token
1719

1820
We wanted to let people reset their CLI tokens in case they are leaked. [#4150](https://github.com/exercism/exercism/issues/4150)
1921

20-
### [Website] Improve experience of "Legacy" or "Practice" solutions in Mentored Mode
22+
## [Website] Improve experience of "Legacy" or "Practice" solutions in Mentored Mode
2123

2224
Have separate restricted queues for core and side exercises when importing solutions created in v1 or in Practice Mode.
2325

24-
### [Website] Make side-exercise mentoring opt-in:
26+
## [Website] Make side-exercise mentoring opt-in:
2527

2628
At the moment some tracks have thousands of side-exercises in the backlog. We're going to change this behaviour so people have to opt-in to mentoring on an exercise-by-exercise basis and can only request mentoring on a handful of exercises at once.
2729

28-
### [Website] Put challenge back to mentor queue if mentor leaves conversation:
30+
## [Website] Put challenge back to mentor queue if mentor leaves conversation:
2931
[#4308](https://github.com/exercism/exercism/issues/4308)
3032

31-
### [Website] Merge mentoring.exercism.io into the main site
33+
## [Website] Merge mentoring.exercism.io into the main site
3234

3335
We wanted to streamline the sign up process, to remove the Google Form and the need to join slack to mentor. This is the first step in a long list of changes we'll make to the mentoring onboarding process.
3436

35-
### [Website] Make the site responsive.
37+
## [Website] Make the site responsive.
3638

3739
The Exercism website is now mobile-responsive thanks to this [huge Pull Request](https://github.com/exercism/website/pull/252) by [@jackhughesweb](https://github.com/jackhughesweb)..
3840

39-
### [Website] Add all notifications
41+
## [Website] Add all notifications
4042

4143
Marked a notification as read but want to still see it? We've added a button for "All notifications" that allows you to see both read and unread notifications. Credit to [@PatrickMcSweeny](https://github.com/PatrickMcSweeny).
4244

43-
### [Website] Comments auto-save as typed
45+
## [Website] Comments auto-save as typed
4446

4547
Nothing is more frustrating than losing your work. To stop accidental tab-closes or refreshes, we've added autosaving as you type comments. Simply go back to the page and you'll find your text is still there!. Credit to [@jackhughesweb](https://github.com/jackhughesweb).
4648

47-
### [Website] Added Dark Theme to the code editor
49+
## [Website] Added Dark Theme to the code editor
4850

4951
We have added a dark theme to the code editor. You can enable it in [your preferences](https://exercism.io/my/settings/preferences/edit). Credit to [@jackhughesweb](https://github.com/jackhughesweb).
5052

51-
### [Tracks] Merged the Javascript and ECMAScript tracks
53+
## [Tracks] Merged the Javascript and ECMAScript tracks
5254

5355
We merged the Javascript and ECMAScript tracks with the aim of focussing the work of the maintainers and mentors into one place, and improve the quality of our offering.

pages/cli.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,31 @@
1-
### Installation
1+
# CLI
2+
3+
## Installation
24

35
The Exercism command line interface (CLI) is a tool that can download exercises, show your progress through a track, and submit your solutions - all from within your terminal. The best way to get started with the CLI is our [Interactive Walkthrough](https://exercism.io/cli-walkthrough). It guides you down the right path depending on your operating system, experience with the command line, etc, and will get your CLI configured.
46

57
If you just want to download the CLI manually and work out how to use it, you can download and install it from [GitHub](https://github.com/exercism/cli/releases/latest). However, please note that we ask that you work through the [Interactive Walkthrough](https://exercism.io/cli-walkthrough) before opening any support requests.
68

79

8-
### Upgrading from pre-v3
10+
## Upgrading from pre-v3
911

1012
If you have a previous version of the CLI and want to upgrade, please read [these instructions](https://github.com/exercism/website-copy/blob/master/pages/cli_v1_to_v2.md).
1113

12-
### Basic usage
14+
## Basic usage
1315
Run the help subcommand to get the full list of available commands.
1416

1517
```bash
1618
exercism help
1719
```
1820

19-
### Configuration
21+
## Configuration
2022
You need to tell the tool who you are. You can find your token in your [settings page](http://exercism.io/my/settings).
2123

2224
```
2325
exercism configure --token=YOUR_API_TOKEN
2426
```
2527

26-
### Troubleshooting
28+
## Troubleshooting
2729

2830
Make sure you are on the latest version.
2931

pages/cli_v1_to_v2.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# CLI v1 to v2
2+
13
If you haven't installed the new version of the command-line client (v3.x), please download the [latest release](https://github.com/exercism/cli/releases/latest). We recommend using our [interactive walkthrough](https://exercism.io/cli-walkthrough) to guide you through the installation and configuration process.
24

35
The CLI for Windows is broken for versions prior to 3.0.5.

pages/code_of_conduct.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
1-
### Introduction
1+
# Code of Conduct
2+
3+
## Introduction
24

35
Exercism is a platform centered around empathetic conversation. We have a low tolerance for communication that makes anyone feel unwelcome, unsupported, insulted or discriminated against.
46

5-
### Seen or experienced something uncomfortable?
7+
## Seen or experienced something uncomfortable?
68

79
If you see or experience abuse, harassment, discrimination, or feel unsafe or upset, please email [email protected]. We will take your report seriously.
810

9-
### Enforcement
11+
## Enforcement
1012

1113
We actively monitor for Code of Conduct (CoC) violations and take any reports of violations extremely seriously. We have banned contributors, mentors and users due to violations.
1214

1315
After we receive a report of a CoC violation, we view that person's conversation history on Exercism and related communication channels and attempt to understand whether someone has deliberately broken the CoC, or accidently crossed a line. We generally reach out to the person who has been reported to discuss any concerns we have and warn them that repeated violations will result in a ban. Sometimes we decide that no violation has occurred and that no action is required and sometimes we will also ban people on a first offence. We strive to be fair, but will err on the side of protecting the culture of our community.
1416

1517
Exercism's leadership reserve the right to take whatever action they feel appropriate with regards to CoC violations.
1618

17-
### The simple version
19+
## The simple version
1820

1921
- Be empathetic
2022
- Be welcoming
@@ -23,7 +25,7 @@ Exercism's leadership reserve the right to take whatever action they feel approp
2325
- Be supportive
2426
- Be polite
2527

26-
### The details
28+
## The details
2729

2830
Exercism should be a safe place for everybody regardless of
2931
- Gender, gender identity or gender expression
@@ -72,7 +74,7 @@ If you say something that is found offensive, and you are called out on it, try
7274
- Ask for tips / help with avoiding making the offence in the future.
7375
- Apologise and ask forgiveness.
7476

75-
### History
77+
## History
7678

7779
This policy was initially adopted from the Front-end London Slack community and has been modified since. A version history can be seen on [GitHub](https://github.com/exercism/website-copy/edit/master/pages/code_of_conduct.md).
7880

0 commit comments

Comments
 (0)