Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fidel Docs variability of terms developer, publisher, account #88

Open
taboca opened this issue Apr 17, 2020 · 1 comment
Open

Fidel Docs variability of terms developer, publisher, account #88

taboca opened this issue Apr 17, 2020 · 1 comment

Comments

@taboca
Copy link

taboca commented Apr 17, 2020

Disclaimer — This feedback is based on a first reading experience, when I found Fidel Docs as part of an interview process; I decided to annotate some points— things I may perceived as ambiguous. Keep in mind that it's my own view and not exactly a problem in the documentation.

The context

  • The notion of account is presented to the developer, right upfront

Screen Shot 2020-04-11 at 15 03 59

The problem

As the developer reads the document, she will stumble at terms like:

  • publisher
  • publisherId
  • accountId
  • developer

Eventually the association between publisher and account is made.

For example at https://docs.fidel.uk/offers/offer-object section:

Screen Shot 2020-04-11 at 15 11 15

For example at https://docs.fidel.uk/offers/create-offer section:

Screen Shot 2020-04-11 at 15 11 48

@taboca
Copy link
Author

taboca commented Apr 17, 2020

Pasting some other notes from my other personal repository.

At dashboard — was said "publisher and developer" roles

According to dashboard, there are publishers and developer roles. This "and" confused me, because it's signalling that they are different things. Would this be publisher-developer instead?

"We are launching a brand new card linked offers platform to connect brands with publishers and developers. You will be able to review and add offers to your programs with a single click. We are currently in private beta, mail us at developer@fidel.uk to request access." 

Screen Shot 2020-04-11 at 14 55 22

The above have appeared in the https://dashboard.fidel.uk/clo/offers/pending from an inline notification message in the UI.

At Fidel Docs — developers — "Offers are created by developers"

  • According to Fidel Docs / Offers, it seems to be about a role that is the publisher-developer — "The Offer object holds the details about a card linked offer. Offers can be created by developers using the Offer API or by Brands/Merchants using the CLO dashboard at clo.fidel.uk. " https://docs.fidel.uk/offers

At Fidel Docs — publisherId was associated with accountId — seemed to suggest that the publisher is the developer

  • Reference to publisher mainly comes from a sample code — at Fidel Docs. https://docs.fidel.uk. In the middle of this document, under Offers object, the table to explain the attributes, then we have "publisherId string Id of the publisher. Refers to accountId."

Screen Shot 2020-04-11 at 15 03 30

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant