adds Sunset language and offramp for sub/showcase

[Christian-MK]

No description provided.

[ross-spencer]

@Christian-MK thanks for this first approach. First review the words look pretty good but I'd like to circle back.

From a maintenance perspective, I'd like to consider:

• collapsing CEX and DEX on this page. (we have given integrators the tools needed to differentiate)
• making sure subsidized feeds are listed first.
• then following in order of sponsored feeds, then subsidized.

For subsidized + sponsored -- we should list the feeds manually, even if we have no sponsored feeds we can just make that clear.

For subsidized feeds we should just state what subsidized means, and what it means to sunset those, i.e. the protocol. I would avoid listing them, and I would make it clear how to identify them on the explorer, and describe the protocol.

Suggested structure using more of a plain-language approach:

- [Available feeds](#available-feeds)
  * [CEX or Dex](#cex-or-dex)
  * [Subsidized feeds](#subsidized-feeds)
    + [Subsidized feeds: Listing](#subsidized-feeds--listing)
    + [Subsidized feeds: Sunset protocol](#subsidized-feeds--sunset-protocol)
  * [Sponsored feeds](#sponsored-feeds)
    + [Sponsored feeds: Listing](#sponsored-feeds--listing)
    + [Sponsored feeds: Sunset protocol](#sponsored-feeds--sunset-protocol)
  * [Showcase feeds](#showcase-feeds)
    + [Sunset protocol for showcase feeds](#sunset-protocol-for-showcase-feeds)

E.g.

# Available feeds

## CEX or Dex

// difference between and how to identify...

## Subsidized feeds

// what they are and what it means to consume them

### Subsidized feeds: Listing

// ada-usd
// fact-ada

### Subsidized feeds: Sunset protocol

// e.g. Will not be sunset. Safe for all. 

## Sponsored feeds

// What they are and what it means to consume them, i.e. if you're not paying for them it isn't safe to rely on them.

### Sponsored feeds: Listing 

### Sponsored feeds: Sunset protocol

// e.g. Feeds will be sunset 2-weeks after payment has not been received. May reappear as showcase feeds.

## Showcase feeds

// Will be cycled through at Orcfax's leisure. Will be sunset appropriately.

### Sunset protocol for showcase feeds

// e.g. Two weeks notice via discord, network status, and optionally, social media. 

I think we're missing clearer delineation on the explorer -- I thought we were showing that feeds were sponsored/subsidized.

It looks like we're 3-6 weeks away from being able to sunset current feeds with the protocol likely:

• finish this page,
• publish this page on socials,
• follow the sunset protocol.

[Christian-MK]

• collapsing CEX and DEX on this page. (we have given integrators the tools needed to differentiate)
• making sure subsidized feeds are listed first.
• then following in order of sponsored feeds, then subsidized.

Thanks for the review @ross-spencer ! I have reorganized the sections accordingly and would love a final read through.
A review of sunsetting timelines:
Sunsetting subsidized feeds: 3 month notice
Sunsetting sponsored feeds: 2 weeks after payment due
Sunsetting showcase feeds: at our discretion
Feed support removal: at our discretion, barring no other obligations

[ross-spencer]

This email link means docs wont build locally. It can be:

[[email protected]](mailto:[email protected]).

Or needs to use the reference style formerly on this page:

[email]: mailto:[email protected]

[ross-spencer]

We still have this open https://github.com/orcfax/issues/issues/208 and I opened this https://github.com/orcfax/issues/issues/229.

In preparation for either, I would remove showcase feeds here entirely.

The status feed is one route we have to announce a sunset -- todo -- check with Gabriel how we might run that protocol.

We could consider some text such as:

Feeds not currently listed as subsidized or sponsored are showcase.

This ensures that:

• long-running feeds receive maintenance on these docs, and maintenance is a light-lift.
• short-running feeds are not a maintenance burden.

I might not even explain that this will be visible on the explorer right now, relying instead on the strength of our communications until the attached issues are addressed.

[ross-spencer]

Suggested change

	For CEX based feeds, fiat currency names follow ISO [4217][cex-2] and ordering
	For CEX based feeds, fiat currency names follow [ISO 4217][cex-2] and ordering

[ross-spencer]

These two sentences are difficult to parse while reading, I wonder if we can simply say:

In all other cases, ordering defers to how pairs appear on the centralized or decentralized exchanges (CEX/DEX).

I see you've linked to the glossary, an explicit info box might help readers and promote it nicely:

INFO: The Glossary provides more information on the terminology and standard adopted by Orcfax.

[ross-spencer]

This can be one table.

[ross-spencer]

This part:

any change to service relating to
subsidized feeds will be announced three months in advance in order to provide
integrators with adequate forewarning.

Ideally will be a the top of this section using plain-language.

E.g.

Changes to service relating to subsidized feeds will be announced three months in advance in order to provide integrators with adequate forewarning.

Alternatively (my preference), the language more terse:

Orcfax has agreed to cover the cost of their support of subsidized feeds enabling them to be used in production. Changes to services relating to subsidized feeds will be announced three months in advance to provide integrators with adequate forewarning.

[ross-spencer]

Suggest:

Sponsored feeds are those supported by an integrator through a subscription, e.g. heartbeat or deviation. Projects utilizing sponsored feeds, but are not paying for the feed, should do so at their own risk. Sponsors may change or remove support at their own discretion.

[ross-spencer]

Suggest:

Orcfax will remove support for sponsored feeds 2-weeks after non-payment where there are no subscribed integrators.

[ross-spencer]

Suggested change

	In order to demonstrate the kinds of feeds which integrators can utilize in
	To demonstrate the kinds of feeds which integrators can utilize in

[ross-spencer]

Suggest a newline:

Suggested change

	highlight them through publication as showcase feeds. Orcfax sets no minimum or
	highlight them through publication as showcase feeds.
	Orcfax sets no minimum or

[ross-spencer]

Suggest removing:

Unless otherwise specified, Orcfax makes no guarantees as to how long showcase
feeds will be offered in this capacity;

And just start with:

Orcfax may change or remove support for showcase feeds at its discretion

[Christian-MK]

Orcfax may change or remove support for showcase feeds at its discretion

have changed to

Orcfax may change or remove support for showcase feeds at its discretion and may
do so without notice.

This work? I think stating that we can do so without notice is helpful

[ross-spencer]

Should this be:

### Sunsetting showcase feeds

[Christian-MK]

Are you referring to ## Removal of feed support? If so no, I had meant for this to be this way. I felt that it was important to state that there could be an instance where Orcfax would remove token support-- not simply ending its showcase

[ross-spencer]

I apologize, this feels like a more substantial inprint of style than I'd normally prefer.

My focus in the comments is on:

• Maintenance (information that changes in short-order and is delivered more frequently should be delivered through fast moving channels; allowing us to focus on information with a longer life-cycle here)
• Getting to the information as quickly as possible. I've described it as more terse language but I think it might be more active voice (versus passive voice).

If there's anything you are able to cherry-pick from my suggestions then I feel it will help.

Two things I wonder if it would make sense to be clearer on:

• communicating the sunset of a feed -- in all cases, we will communicate through our status/social channels about the sunsetting of a feed (probably repeating some of the language hee0
• Terms of service: https://docs.orcfax.io/terms-of-service <-- do we want to draw attention to the terms of service? (i am torn, because this page is not a legal page and don't want to pretend it is, but the terms of service are important too)

[ross-spencer]

Nb,

Sunsetting subsidized feeds: 3 month notice
Sunsetting sponsored feeds: 2 weeks after payment due
Sunsetting showcase feeds: at our discretion

Will add this to the Trello to discuss later.

[ross-spencer]

Gabrriel has implemented the filter feature here! https://github.com/orcfax/issues/issues/229#issuecomment-2683394906

[Christian-MK]

@ross-spencer I have added your edits! All good to merge?

[Christian-MK]

@gchartier after our last call re prettier and formatting my pushes are going through fine but I keep recieving the following emails after each

[orcfax/docs] Run failed: .github/workflows/dependabot.yml - christian/sun-setting (755941f)
.github/workflows/dependabot.yml: No jobs were run

[ross-spencer]

It's looking good, and approving so you're not held up merging.

I only have one last query which can be addressed now or maybe later, but under the section "removing feed support"

In the absence of a subscription to support a feed's publication or business decisions which may incentivize subsidization, Orcfax may suspend or remove technical support for feeds at its discretion.

Unless otherwise required (e.g. in the case of subsidized feeds) Orcfax may remove support for such a feed without notice.

maybe this just needs removing? "or business decisions which may incentivize subsidization, " <-- it doesn't feel very clear.

Suggest:

Unless a feed is supported, i.e. sponsored and paid for by a third-party, or subsidized through Orcfax, we may suspend or remove technical support for sponsored feeds at our own discretion.

Once merged, the text here should help Peter's more legalese text for any user agreements; and maybe vice versa.

[Christian-MK]

Unless a feed is supported, i.e. sponsored and paid for by a third-party, or subsidized through Orcfax, we may suspend or remove technical support for sponsored feeds at our own discretion.

changed per your suggestion