Skip to content

Commit 436808c

Browse files
committed
Address PR feedback
1 parent 68a7bd1 commit 436808c

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -115,9 +115,9 @@ Whenever a pull request is made, the GitHub Actions workflow defined in [`.githu
115115

116116
Making sure that a pull request passes every CI check is part of the code review process.
117117

118-
## Search indices
118+
## Search indexes
119119

120-
Search on plotly.com docs pages is powered by Algolia indices that are updated separately from the site build. There are four indices, each updated by its own `make` target:
120+
Search on plotly.com docs pages is powered by Algolia indexes that are updated separately from the site build. There are four indexes, each updated by its own `make` target:
121121

122122
| Index | Search on | Update with |
123123
| --- | --- | --- |
@@ -126,13 +126,13 @@ Search on plotly.com docs pages is powered by Algolia indices that are updated s
126126
| `r_docs` | https://plotly.com/r/, https://plotly.com/ggplot2/ | `make update_r_search` |
127127
| `schema` | reference pages (e.g. https://plotly.com/python/reference) | `make update_ref_search` |
128128

129-
You can browse the indices at https://www.algolia.com/apps/7EK9KHJW8M/explorer/browse/.
129+
You can browse the indexes at https://www.algolia.com/apps/7EK9KHJW8M/explorer/browse/.
130130

131-
**When to update:** Run the appropriate `update_*_search` target whenever a new tutorial is added to the corresponding `_posts/` directory. The `schema` index should be updated when a new plotly.js version is released.
131+
**When to update:** Run the appropriate `update_*_search` target whenever a new tutorial is added to the corresponding `_posts/` directory. Run the `schema` index update command when a new plotly.js version is released.
132132

133133
**How to exclude files from an index:** Each search index has its own Jekyll config (`_config_python_search.yml`, `_config_r_search.yml`, etc.) with an `algolia.excluded_files` list. Add files or paths there to keep them out of search results.
134134

135-
**Algolia API key:** Updating the indices requires a private Algolia API key set as an environment variable. Request it from a Plotly maintainer via an issue on this repository.
135+
**Algolia API key:** Updating the indexes requires a private Algolia API key set as an environment variable. Request it from a Plotly maintainer via an issue on this repository.
136136

137137
Run `make help` to see all available `make` targets, including search-index and upstream-fetch commands.
138138

style_README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The scss and Jekyll instance have been separated to allow for faster updates to
1010

1111
### Usage
1212

13-
Once the repo has been cloned successfully (see the main [README.md](https://github.com/plotly/graphing-library-docs/blob/master/README.md#how-to-get-the-application-working-locally)), run `npm install` to install gulp and the necessary dependencies.
13+
Once you have successfully cloned the repo (see the main [README.md](https://github.com/plotly/graphing-library-docs/blob/master/README.md#how-to-get-the-application-working-locally)), run `npm install` to install gulp and the necessary dependencies.
1414

1515
Generally it's best to work with two terminal sessions: one for `bundle exec jekyll …` and another to keep the `gulp` task running.
1616

@@ -22,7 +22,7 @@ Generally it's best to work with two terminal sessions: one for `bundle exec jek
2222

2323
It's a bit of a hassle to make concurrent updates to markup and scss. Any time you update an html/js file you'll have to run `bundle exec jekyll build` (or run `bundle exec jekyll serve` with Jekyll watching for changes). Jekyll's watch mode can be slow on this repo because of its size; building on demand is sometimes preferable.
2424

25-
When you run `bundle exec jekyll …`, Jekyll will regenerate `styles.css` — so if you modify any scss file and save it, Jekyll's output may overwrite your changes. Run `gulp build` again to regenerate the css after Jekyll runs.
25+
When you run `bundle exec jekyll …`, Jekyll regenerates `styles.css` — so if you modify any scss file and save it, Jekyll's output may overwrite your changes. Run `gulp build` again to regenerate the css after Jekyll runs.
2626

2727
### folder structure
2828

0 commit comments

Comments
 (0)