Skip to content

Commit 8f3e85e

Browse files
authored
Fix images on Contributing page (#12)
1 parent ebc035f commit 8f3e85e

File tree

9 files changed

+7
-7
lines changed

9 files changed

+7
-7
lines changed

docs/contributing.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Also, see [configuring notifications](https://docs.github.com/en/github/managing
2424
Alternatively, consider subscribing to this repository in the [GitHub Slack](https://slack.github.com/) app by searching for it under "Apps" inside Slack.
2525

2626
</div>
27-
<img src="../img/github-watch.png" alt="GitHub Watch" className="img-xs-right" />
27+
<img src="/experimenter-docs/img/github-watch.png" alt="GitHub Watch" className="img-xs-right" />
2828
</div>
2929

3030
## GitHub Workflow
@@ -39,13 +39,13 @@ If you aren't familiar with using Git via the command line, we recommend using t
3939

4040
In the following sections, you'll find corresponding links to the GH UI directly under each section title. If you need to edit a file, you'll click on the "Edit" button:
4141

42-
<img src="../img/edit-this-file.png" alt="edit this file" className="img-sm" />
42+
<img src="/experimenter-docs/img/edit-this-file.png" alt="edit this file" className="img-sm" />
4343

4444
You'll be brought to the GitHub editor page for that file. If you're creating a new document, you'll see a similar editor.
4545

4646
When you're satisfied with your changes or new document, at the bottom of the page, enter a commit message and optional description. Be sure to have the option "Create a new branch" selected, the name of which can be anything, but **if you also need to make edits to the sidebar**, you'll want to keep the branch name in mind.
4747

48-
<img src="../img/commit-changes.png" alt="Commit changes" className="img-xl" />
48+
<img src="/experimenter-docs/img/commit-changes.png" alt="Commit changes" className="img-xl" />
4949

5050
Click `Commit changes` and you'll be brought to a pull request view comparing your new branch to `main`. If you don't need to make updates to the sidebar, see the [Pull Request Workflow](#pull-request-workflow) section and click `Create pull request`.
5151

@@ -121,7 +121,7 @@ Tip: If you just need to update the sidebar label and not the page title (atypic
121121

122122
1. Create a new top-level internal link to the doc or modify an existing one
123123

124-
<img src="../img/top-level-link.png" alt="top-level link" className="img-lg" />
124+
<img src="/experimenter-docs/img/top-level-link.png" alt="top-level link" className="img-lg" />
125125

126126
To set this up, you'll have to modify the `sidebars.js` file locally or through the GH UI link above - all it needs is the `id` that is set at the top of the MD file. It will look something like this to reflect the screenshot:
127127

@@ -138,7 +138,7 @@ module.exports = {
138138
2. Create a new top-level external link to the doc
139139
140140
<div className="flex-lg">
141-
<img src="../img/top-level-external-link.png" alt="top-level external link" className="img-sm-left" />
141+
<img src="/experimenter-docs/img/top-level-external-link.png" alt="top-level external link" className="img-sm-left" />
142142
143143
<div>
144144
@@ -166,7 +166,7 @@ You'll want to make sure `type` is set to `"link"`.
166166
3. Create a new internal link to the doc in an existing or new category
167167

168168
<div className="flex-lg">
169-
<img src="../img/category-link.png" alt="category link" className="img-sm-left order-2-lg" />
169+
<img src="/experimenter-docs/img/category-link.png" alt="category link" className="img-sm-left order-2-lg" />
170170
<div>
171171

172172
In Docusaurusland, sidebar menu items with a down caret are called "categories."
@@ -195,7 +195,7 @@ module.exports = {
195195
4. Create a new external link to a doc in an existing or new category
196196
197197
<div className="flex-lg mb-16px">
198-
<img src="../img/category-external-link.png" alt="category link" className="img-sm-left" />
198+
<img src="/experimenter-docs/img/category-external-link.png" alt="category link" className="img-sm-left" />
199199
<div>
200200
201201
The code changes for this option essentially combine options 2 and 3.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)