Skip to content

Fix some links in configlet docs #159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 24, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions building/configlet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,28 @@

## Linting

The primary function of configlet is to do _linting_: checking if a track's configuration files are properly structured - both syntactically and semantically. Misconfigured tracks may not sync correctly, may look wrong on the website, or may present a suboptimal user experience, so configlet's guards play an important part in maintaining the integrity of Exercism. The full list of rules that are checked by the linter can be found [here](./linting.md).
The primary function of configlet is to do _linting_: checking if a track's configuration files are properly structured - both syntactically and semantically. Misconfigured tracks may not sync correctly, may look wrong on the website, or may present a suboptimal user experience, so configlet's guards play an important part in maintaining the integrity of Exercism. The full list of rules that are checked by the linter can be found [here](./lint).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@iHiD So this PR got merged and deployed, and when I click this link on https://exercism.lol/docs/building/configlet, I get a 500 error. I'm guessing it's because it tries to take me to https://exercism.lol/docs/building/lint instead of https://exercism.lol/docs/building/configlet/lint

The same is true about some other links that starts with ./.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess @ee7 noticed the same thing at the same time and opened #160 :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I saw this too. I just created #160 to follow up.


## Generating documents

The secondary function of configlet is to generate documents. There are two types of documents that configlet can generate:

1. A Concept Exercise's [`introduction.md` file](./generating-documents.md#documentconceptexercisesintroductionmdfile).
1. A Practice Exercise's [`README.md` file](./generating-documents.md#documentpracticeexercisesreadmemdfile).
1. A Concept Exercise's [`introduction.md` file](./generating-documents#document-concept-exercises-introductionmd-file).
1. A Practice Exercise's [`instructions.md` file](./generating-documents#document-practice-exercises-instructionsmd-file).

How these documents are generated can be found [here](./generating-documents.md).
How these documents are generated can be found [here](./generating-documents).

## Syncing test data

The tertiary function of configlet is to sync test data. Each implemented [Practice Exercise](../../product/practice-exercises.md) for which test data exists in the [problem-specifications repo](https://github.com/exercism/problem-specifications) _must_ contain a `.meta/tests.toml` file. The goal of this file is to keep track of which tests are implemented by the exercise. Tests in this file are identified by their UUID and each test has a boolean value that indicates if it is implemented by that exercise.
The tertiary function of configlet is to sync test data. Each implemented [Practice Exercise](./tracks/practice-exercises) for which test data exists in the [problem-specifications repo](https://github.com/exercism/problem-specifications) _must_ contain a `.meta/tests.toml` file. The goal of this file is to keep track of which tests are implemented by the exercise. Tests in this file are identified by their UUID and each test has a boolean value that indicates if it is implemented by that exercise.

How to sync the contents of the `.meta/tests.toml` can be found [here](./syncing.md)
How to sync the contents of the `.meta/tests.toml` can be found [here](./sync)

## Generating UUIDs

Exercises, tracks and concepts are identified by a UUID.

How to generate UUIDs can be found [here](./uuids.md).
How to generate UUIDs can be found [here](./uuid).

## Usage

Expand Down
2 changes: 1 addition & 1 deletion building/configlet/uuid.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Generating UUIDs

Exercises, tracks and concepts are identified by a UUID. [configlet](../) can generate new, valid UUIDs.
Exercises, tracks and concepts are identified by a UUID. [configlet](./) can generate new, valid UUIDs.

## Usage

Expand Down