forked from plotly/documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
/
make_instructions.txt
101 lines (73 loc) · 4.53 KB
/
make_instructions.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
#################
MAKE INSTRUCTIONS
#################
Contents:
Overview
Setup
FAQ
Available targets
################################################################################
Overview
The functions found in this makefile are associated with the Algolia search
indices which provide search functionality on Plotly's documentation pages.
We have multiple search indices:
- js_docs (https://www.algolia.com/apps/7EK9KHJW8M/explorer/browse/js_docs)
- Search on: https://plot.ly/javascript/
- Includes html files found in documentation/_posts/javascript
- Update by running `make update_js_search` locally from the root of
the documentation repo
- python_docs (https://www.algolia.com/apps/7EK9KHJW8M/explorer/browse/python_docs)
- Search on: https://plot.ly/python/ and https://plot.ly/pandas/
- Includes html files found in documentation/_posts/python
- Update by running `make update_python_search` locally from the root of
the documentation repo
- r_docs (https://www.algolia.com/apps/7EK9KHJW8M/explorer/browse/r_docs)
- Search on: https://plot.ly/r/ and https://plot.ly/ggplot2/
- Includes md files found in documentation/_posts/r and
documentation/_posts/ggplot2
- Update by running `make update_r_search` locally from the root of
the documentation repo
- schema (https://www.algolia.com/apps/7EK9KHJW8M/explorer/browse/schema)
- Search on chart attribute reference pages
(i.e.: https://plot.ly/javascript/reference,
https://plot.ly/matlab/reference, https://plot.ly/python/reference
https://plot.ly/r/reference)
- Includes all schema from plotly.js (https://api.plot.ly/v2/plot-schema)
- Update by running `make update_ref_search` locally from the root of
the documentation repo
################################################################################
################################################################################
Setup
In order to update the indices you will need to have Ruby and Jekyll
installed. For more information on setting up these tools see our
documentation contributing guide:
https://github.com/plotly/documentation/blob/source-design-merge/Contributing.md
Additionally, you will need to set the Algolia API KEY as an environment
variable on your local machine. This key should remain private, please
contact [email protected] for the key or more information.
################################################################################
################################################################################
FAQ
How to Update:
You can update the index of your choice by running the available target
functions (for example: `make update_python_search`) listed below from
the root of the documentation repo (i.e. the same path as this file).
When to Update:
The search index should be updated when a new doc is added to the associated
directory (i.e. run `make update_python_search` when adding a NEW html file
to documentation/_posts/python.) The schema index should be updated when a
new plotly.js version is added to streambed.
How to Exclude Files from the Search Index:
Each search index has an associated _config.yml (i.e. _config_js_search.yml,
_config_python_search.yml, _config_r_search.yml). In the associated .yml file
under algolia there is a list of excluded files. You can add any files or paths
that should not be included in the search to that list.
################################################################################
################################################################################
Available targets (i.e. $ make target):
search_readme -> `less` this file
update_js_search -> update the plotly.js search index: https://www.algolia.com/apps/7EK9KHJW8M/explorer/browse/js_docs
update_python_search -> update the python search index: https://www.algolia.com/apps/7EK9KHJW8M/explorer/browse/python_docs
update_r_search -> update the r search index: https://www.algolia.com/apps/7EK9KHJW8M/explorer/browse/r_docs
update_ref_search -> update the schema search index: https://www.algolia.com/apps/7EK9KHJW8M/explorer/browse/schema
################################################################################