fix: config store documentation fix (#1160) #1161
Conversation
| @@ -41,7 +41,7 @@ Dynamic backends are a compute feature that allow services to define backends fo | |||
|
|
|||
| When dynamic backends are enabled at the service level, the explicit `backend` option is no longer required for `fetch()` requests, and will instead be automatically created. | |||
|
|
|||
| In addition, custom backend confiuration options can then also be provided through the [`Backend()`](../fastly:backend/Backend/Backend.mdx) constructor. | |||
There was a problem hiding this comment.
@gaylin is this worth a docs bug bounty? 😄
The breadcrumbs start here fastly documentation before going to the SDK Reference
There was a problem hiding this comment.
Sadly, no. It's not a typo just a mistake. :) But with that said, we officially will make you an honorary tech writer for a day. <3
| @@ -23,7 +23,7 @@ new ConfigStore(name); | |||
| ### Parameters | |||
|
|
|||
| - `name` _: string_ | |||
| - The name of the [Fastly Edge Dictionary](https://docs.fastly.com/en/guides/about-edge-dictionaries) that this `ConfigStore` instance should provide access to. | |||
| - The name of the [Fastly Edge ConfigStore](https://www.fastly.com/documentation/reference/api/services/resources/config-store/) that this `ConfigStore` instance should provide access to. | |||
There was a problem hiding this comment.
Guess what you've stepped into without realizing it... :-)
As we're discussing in another thread right now, this is incorrect, as the name provided to the constructor must be the name of the service's resource link which links to the Config Store, not the name of the Config Store itself. This is also true for KV Stores and Secret Stores, so whatever language we come up with to address that here should be applied to those resource types too.
| - The name of the [Fastly Edge ConfigStore](https://www.fastly.com/documentation/reference/api/services/resources/config-store/) that this `ConfigStore` instance should provide access to. | |
| - The name of the [Fastly Config Store](https://www.fastly.com/documentation/reference/api/services/resources/config-store/) that this `ConfigStore` instance should provide access to. |
There was a problem hiding this comment.
So we can either change the wording and drop a breakcrumb so it eventually goes to the source.
The name provided must be the service's resource link [name](https://www.fastly.com/documentation/guides/concepts/edge-state/dynamic-config/#config-stores).
or
Add a note
Note The name is the service's resource link name which links to the Config Store, not the name of the Config Store itself.
I prefer the first but I'll include either in the other resources docs as well, what do you think?
There was a problem hiding this comment.
I'll defer to @gaylin for that one.
There was a problem hiding this comment.
@dbarshop , could you weigh in here please on the terminology that you've worked out with Eng and Legal in the past?
There was a problem hiding this comment.
(commenting here to subscribe to the thread and see the outcome for the Rust SDK as well)
|
This PR will also need to update the documentation for the |
updated in 38d3335 |
Co-authored-by: Kevin P. Fleming <[email protected]>
Co-authored-by: Kevin P. Fleming <[email protected]>
Co-authored-by: Kevin P. Fleming <[email protected]>
Co-authored-by: Deanna Barshop <[email protected]>
Co-authored-by: Deanna Barshop <[email protected]>
Co-authored-by: Deanna Barshop <[email protected]>
Co-authored-by: Deanna Barshop <[email protected]>
vcarvajal-sigsci
force-pushed
the
config_store_docs_updates
branch
from
65ae1f7 to
55374c6
Compare
#1160