Skip to content

Commit 381cc38

Browse files
corryrootzach-carr
authored andcommitted
(DOCSP-27623): Updated refresh language.
1 parent 627b15c commit 381cc38

9 files changed

+33
-33
lines changed

source/dashboard-permissions.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@ following dashboard permissions are available:
3939

4040
- Filter dashboards based on available fields.
4141

42-
- Configure auto-refresh settings and manually refresh dashboard
42+
- Configure refresh settings and manually refresh dashboard
4343
data.
4444

4545
.. note::
4646

47-
.. include:: /includes/fact-auto-refresh-persistence.rst
47+
.. include:: /includes/fact-refresh-persistence.rst
4848

4949
* - Author
5050
- Has all privileges of ``Viewer`` and can also:

source/dashboard-refresh.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,24 +16,24 @@ Refresh Dashboard Data
1616
date with the backing data source. You can also manually refresh
1717
dashboard data at any time.
1818

19-
.. _configure-auto-refresh:
19+
.. _configure-refresh:
2020

21-
Configure Auto Refresh Settings
22-
-------------------------------
21+
Configure Refresh Settings
22+
--------------------------
2323

2424
Charts on a dashboard automatically refresh once their data becomes out
2525
of date. You can specify how stale your charts' data can be before it is
2626
refreshed. This is known as your staleness tolerance. The default
2727
behavior is to refresh when data is one hour stale.
2828

29-
To configure auto-refresh settings for a dashboard:
29+
To configure refresh settings for a dashboard:
3030

3131
1. Select a dashboard from the :guilabel:`Dashboards` page.
3232

3333
#. Click the :guilabel:`Refresh` icon at
3434
the top of the dashboard.
3535

36-
#. Click :guilabel:`Auto Refresh Settings` from the dropdown.
36+
#. Click :guilabel:`Refresh Settings` from the dropdown.
3737

3838
#. Select your data staleness tolerance from the dropdown.
3939
|charts-short| supports the following staleness tolerances:
@@ -67,7 +67,7 @@ To manually refresh dashboard data:
6767

6868
#. Click the :guilabel:`Refresh` icon.
6969

70-
#. Select :guilabel:`Force Refresh All Charts` from the dropdown.
70+
#. Select :guilabel:`Force Refresh` from the dropdown.
7171

7272
Manually Refresh a Single Chart
7373
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -91,7 +91,7 @@ Refresh Behavior
9191
older than your specified staleness tolerance are refreshed.
9292
|charts-short| does not refresh the entire dashboard at once.
9393

94-
- .. include:: /includes/fact-auto-refresh-persistence.rst
94+
- .. include:: /includes/fact-refresh-persistence.rst
9595

9696
- Hover over the timer at the bottom of the chart to view more
9797
information.

source/dashboards.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ Refresh Dashboard Data
117117
date with the backing data source. You can also manually refresh
118118
dashboard data at any time.
119119

120-
To learn how to configure auto refresh settings and underlying
120+
To learn how to configure refresh settings and underlying
121121
refresh behavior, see :doc:`/dashboard-refresh`.
122122

123123
.. _get-chart-data-dashboard:
@@ -291,7 +291,7 @@ To enter the fullscreen view for dashboards:
291291
<dashboard-rearrange-chart>`, and :ref:`edit
292292
<dashboard-edit-chart>` charts by hovering over the desired chart.
293293

294-
- Configure auto-refresh settings and manually refresh chart data.
294+
- Configure refresh settings and manually refresh chart data.
295295

296296
- Enter the :ref:`fullscreen charts view <fullscreen-charts-view>`.
297297

source/embedded-chart-options.txt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ a variety of options. Options are available to charts embedded with the
111111
To learn how |charts| loads data from the cache when
112112
loading or refreshing the chart based on the
113113
``autoRefresh`` and ``maxDataAge`` values, see
114-
:ref:`auto-refresh-behavior`.
114+
:ref:`refresh-behavior`.
115115

116116
- no
117117

@@ -214,7 +214,7 @@ a variety of options. Options are available to charts embedded with the
214214
To learn how |charts| loads data from the cache when
215215
loading or refreshing the chart based on the
216216
``setAutoRefresh`` and ``setMaxDataAge`` values, see
217-
:ref:`auto-refresh-behavior`.
217+
:ref:`refresh-behavior`.
218218

219219
* - ``setFilter(filter: object)``
220220
- Applies a :ref:`query filter <filter-embedded-charts>`
@@ -255,8 +255,8 @@ a variety of options. Options are available to charts embedded with the
255255
specify a refresh interval for your chart, as well as a light or
256256
dark display theme.
257257

258-
Configure Auto Refresh and Data Caching Behavior
259-
------------------------------------------------
258+
Configure Refresh and Data Caching Behavior
259+
-------------------------------------------
260260

261261
Use the ``autoRefresh`` query parameter to configure the chart
262262
to refresh automatically.
@@ -271,7 +271,7 @@ a variety of options. Options are available to charts embedded with the
271271

272272
To learn how |charts| loads data from the cache when loading
273273
or refreshing the chart based on the ``autoRefresh`` and
274-
``maxDataAge`` values, see :ref:`auto-refresh-behavior`.
274+
``maxDataAge`` values, see :ref:`refresh-behavior`.
275275

276276
Use the options on the
277277
:guilabel:`Unauthenticated` tab on the :guilabel:`Embed Chart`
@@ -477,13 +477,13 @@ a variety of options. Options are available to charts embedded with the
477477
attribution=false
478478
"></iframe>
479479

480-
.. _auto-refresh-behavior:
480+
.. _refresh-behavior:
481481

482-
Auto Refresh and Data Caching Behavior
483-
--------------------------------------
482+
Refresh and Data Caching Behavior
483+
---------------------------------
484484

485485
The following table describes how |charts| loads data from the cache
486486
when loading or refreshing the chart based on the
487487
``autoRefresh`` and ``maxDataAge`` values.
488488

489-
.. include:: /includes/autorefresh-maxdataage-values.rst
489+
.. include:: /includes/refresh-maxdataage-values.rst

source/embedded-dashboard-options.txt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ dashboards embedded with the :ref:`Embedding SDK
109109
To learn how |charts| loads data from the cache when
110110
loading or refreshing the dashboard based on the
111111
``autoRefresh`` and ``maxDataAge`` values, see
112-
:ref:`auto-refresh-behavior-dashboard`.
112+
:ref:`refresh-behavior-dashboard`.
113113

114114
- no
115115

@@ -218,7 +218,7 @@ dashboards embedded with the :ref:`Embedding SDK
218218
To learn how |charts| loads data from the cache when
219219
loading or refreshing the dashboard based on the
220220
``setAutoRefresh`` and ``setMaxDataAge`` values, see
221-
:ref:`auto-refresh-behavior-dashboard`.
221+
:ref:`refresh-behavior-dashboard`.
222222

223223
* - ``setTheme(theme: 'dark' | 'light')``
224224
- Current theme of the embedded dashboard. When
@@ -250,8 +250,8 @@ dashboards embedded with the :ref:`Embedding SDK
250250
width. Query parameters allow you to specify a light or dark
251251
display theme.
252252

253-
Configure Auto Refresh and Data Caching Behavior
254-
------------------------------------------------
253+
Configure Refresh and Data Caching Behavior
254+
-------------------------------------------
255255

256256
Use the ``autoRefresh`` query parameter to configure the
257257
dashboard to refresh automatically.
@@ -267,7 +267,7 @@ dashboards embedded with the :ref:`Embedding SDK
267267
To learn how |charts| loads data from the cache when loading
268268
or refreshing the dashboard based on the ``autoRefresh`` and
269269
``maxDataAge`` values, see
270-
:ref:`auto-refresh-behavior-dashboard`.
270+
:ref:`refresh-behavior-dashboard`.
271271

272272
Use the options on the
273273
:guilabel:`Unauthenticated` tab on the
@@ -451,13 +451,13 @@ dashboards embedded with the :ref:`Embedding SDK
451451
attribution=false
452452
"></iframe>
453453

454-
.. _auto-refresh-behavior-dashboard:
454+
.. _refresh-behavior-dashboard:
455455

456-
Auto Refresh and Data Caching Behavior
457-
--------------------------------------
456+
Refresh and Data Caching Behavior
457+
---------------------------------
458458

459459
The following table describes how |charts| loads data from the cache
460460
when loading or refreshing the dashboard based on the
461461
``autoRefresh`` and ``maxDataAge`` values.
462462

463-
.. include:: /includes/autorefresh-maxdataage-values.rst
463+
.. include:: /includes/refresh-maxdataage-values.rst
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
Auto-refresh settings are stored in the local browser state. These
1+
Refresh settings are stored in the local browser state. These
22
settings are not persisted with the dashboard or shared between users.
File renamed without changes.

source/includes/steps-enable-embedding-iframe-anon.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,14 @@ ref: select-iframe-panel
3535
level: 4
3636
content: |
3737
Selecting the :guilabel:`Iframe` panel reveals the iframe embedding code
38-
and allows you to set autorefresh and display theme options.
38+
and allows you to set refresh and display theme options.
3939
---
4040
stepnum: 8
4141
title: Set options.
4242
ref: iframe-set-options
4343
level: 4
4444
content: |
45-
a. The autorefresh interval determines how often your chart refreshes
45+
a. The refresh interval determines how often your chart refreshes
4646
with new data, if any, from your data source.
4747
4848
#. You can select the :guilabel:`Light` or :guilabel:`Dark` display theme

source/release-notes.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1415,7 +1415,7 @@ Bug fixes in this release:
14151415

14161416
Improvements in this release:
14171417

1418-
- Option to :ref:`specify autorefresh period <embed-options-refresh>`
1418+
- Option to :ref:`specify refresh period <embed-options-refresh>`
14191419
in embedded charts.
14201420

14211421
- Option to :ref:`specify a custom filter <embed-options-filter>` in

0 commit comments

Comments
 (0)