Skip to content

Commit

Permalink
Fix links to sample instructions on templates
Browse files Browse the repository at this point in the history
When a page (such as templates/contributing.md) links to an image, the image source reference needs to be relative to the final URL of the page. Since the image is in templates/ and the page URL is templates/contributing/, the image ref should be ../sample-instructions.png (going up one level so that we are referencing the image in the template dir).

Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
  • Loading branch information
carolynvs committed Mar 22, 2023
1 parent 45d965c commit 00ff912
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion website/content/maintainers/templates/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The [CONTRIBUTING.md template](https://github.com/cncf/project-template/blob/mai
Copy the template file into your repository.
There are instructions for filling out the template that look like the example below:

![screenshot of the CONTRIBUTING.md template, there is a link to instructions, and a warning emoji with text explaining how to fill out this section of the template](sample-instructions.png)
![screenshot of the CONTRIBUTING.md template, there is a link to instructions, and a warning emoji with text explaining how to fill out this section of the template](../sample-instructions.png)

Some links are specific to your project.
Search for the word TODO in the markdown for links that need to be customized.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Copy the template file into your repository, and rename it `GOVERNANCE.md`.

There are instructions for filling out the template that look like the example below:

![screenshot of the CONTRIBUTING.md template, there is a link to instructions, and a warning emoji with text explaining how to fill out this section of the template](sample-instructions.png)
![screenshot of the CONTRIBUTING.md template, there is a link to instructions, and a warning emoji with text explaining how to fill out this section of the template](../sample-instructions.png)

Some links are specific to your project.
Search for the word TODO in the markdown for links that need to be customized.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Copy the template file into your repository, and rename it `GOVERNANCE.md`.

There are instructions for filling out the template that look like the example below:

![screenshot of the CONTRIBUTING.md template, there is a link to instructions, and a warning emoji with text explaining how to fill out this section of the template](sample-instructions.png)
![screenshot of the CONTRIBUTING.md template, there is a link to instructions, and a warning emoji with text explaining how to fill out this section of the template](../sample-instructions.png)

Some links are specific to your project.
Search for the word TODO in the markdown for links that need to be customized.
Expand Down
2 changes: 1 addition & 1 deletion website/content/maintainers/templates/maintainers.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Copy the template file into your repository.

There are instructions for filling out the template that look like the example below:

![screenshot of the CONTRIBUTING.md template, there is a link to instructions, and a warning emoji with text explaining how to fill out this section of the template](sample-instructions.png)
![screenshot of the CONTRIBUTING.md template, there is a link to instructions, and a warning emoji with text explaining how to fill out this section of the template](../sample-instructions.png)

Some links are specific to your project.
Search for the word TODO in the markdown for links that need to be customized.
Expand Down
2 changes: 1 addition & 1 deletion website/content/maintainers/templates/reviewing.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The [REVIEWING.md template](https://github.com/cncf/project-template/blob/main/R
Copy the template file into your repository.
There are instructions for filling out the template that look like the example below:

![screenshot of the REVIEWING.md template, there is a link to instructions, and a warning emoji with text explaining how to fill out this section of the template](sample-instructions.png)
![screenshot of the REVIEWING.md template, there is a link to instructions, and a warning emoji with text explaining how to fill out this section of the template](../sample-instructions.png)

When you finish editing the template, remove the Instruction links that explain how to fill out the template. Also remove any ⚠️ prompts and their explanatory text.

Expand Down

0 comments on commit 00ff912

Please sign in to comment.