Confirmed users
365
edits
Support/Kitsune/SUMO API: Difference between revisions
→Contributors with their Own site
| (14 intermediate revisions by 2 users not shown) | |||
| Line 17: | Line 17: | ||
=== Product Page === | === Product Page === | ||
''' | '''Article Snippets''' | ||
(similar example: http://www.mozilla.com/en-US/firefox/security/) | (similar example: http://www.mozilla.com/en-US/firefox/security/) | ||
* A new product is going to be launched and a site is created | * A new product is going to be launched and a site is created | ||
* SUMO content is created for the product. | * SUMO content is created for the product. | ||
* Engagement wants to include some FAQs in the new site. | * Engagement wants to include some FAQs in the new site. | ||
* To ensure that the content is up to date the Title for the link and | * To ensure that the content is up to date the Title for the link and the search summary is pulled from the SUMO FAQs, calling for an specific article. | ||
* The content is then formatted with the CSS of the page. | * The content is then formatted with the CSS of the page. | ||
''' | '''Article Content''' | ||
(example: http://www.mozilla.com/en-US/mobile/sync/) | (example: http://www.mozilla.com/en-US/mobile/sync/) | ||
* In the same product page, engagement decides to explain how to configure the new feature. | * In the same product page, engagement decides to explain how to configure the new feature. | ||
| Line 32: | Line 31: | ||
* Instead of hardcoding the steps, they include a call to the API to fetch an specific article that is always updated. | * Instead of hardcoding the steps, they include a call to the API to fetch an specific article that is always updated. | ||
* The content will be customized based on the user reading it (i.e. user agent) and the page's CSS. | * The content will be customized based on the user reading it (i.e. user agent) and the page's CSS. | ||
** We will probably need to insert our own CSS/JS, for things like /buttons/ or to hide showfor content. | |||
''' | '''Top Articles''' | ||
* The team working on BrowserID wants to include a page for Users explaining what it is. | * The team working on BrowserID wants to include a page for Users explaining what it is. | ||
* SUMO has content explaining how to use it and how to troubleshoot it. | * SUMO has content explaining how to use it and how to troubleshoot it. | ||
* BrowserID team decides to include a widget with the most popular topics. | * BrowserID team decides to include a widget with the most popular topics. | ||
* They embed a query to the SUMO database that presents a configurable (amount of items, tags) list of the top articles relevant to the product. | * They embed a query to the SUMO database that presents a configurable (amount of items, tags) list of the top articles relevant to the product. | ||
** What happens when people click on the links? Are thy sent to SUMO? | |||
* The list can be formatted with the CSS to match the look and feel of the site. | * The list can be formatted with the CSS to match the look and feel of the site. | ||
''' | '''Auto Customization - NOT PRIORITIZED''' | ||
* The AMO team has created a dashboard where you can see all the add ons that you have downloaded. | * The AMO team has created a dashboard where you can see all the add ons that you have downloaded. | ||
* They want to include a list of relevant SUMO articles. | * They want to include a list of relevant SUMO articles. | ||
| Line 48: | Line 49: | ||
=== Contributors with their Own site === | === Contributors with their Own site === | ||
Contributor Widget | '''Contributor Widget - NOT PRIORITIZED''' | ||
*David is a contributor | *David is a contributor | ||
| Line 57: | Line 58: | ||
**Filter by keyword. | **Filter by keyword. | ||
*The widget also shows the Karma level of this user. | *The widget also shows the Karma level of this user. | ||
Not sure this is really necessary. It would add nothing for anyone beyond David. -Kadir | |||
Search box redirecting to SUMO | Search box redirecting to SUMO | ||
| Line 81: | Line 84: | ||
== Features == | == Features == | ||
=== Critical === | === P0 - Critical === | ||
This is the basic collection of features the service need to have in order to officially go live. | |||
* The API should return the article content in text format. | |||
* It should offer the following features: | |||
** Content | |||
*** A webmaster can fetch the whole SUMO article querying the API with the Title of the article. | |||
** For: | |||
*** Possibility to Retrieve a specific {for}. | |||
*** Capability to offer dynamic content that gets customized based on the User Agent. | |||
** Style: | |||
*** Offer predefined CSS (this can be done as a file attached to the documentation). | |||
*** Possibility to customize the presentation with a custom CSS. | |||
* The API needs to be documented. | |||
=== Important === | === P1 - Important === | ||
The following list of features should be the ones that follow the initial launch and should be ready in 2 quarters after the official launch of the service. | The following list of features should be the ones that follow the initial launch and should be ready in 2 quarters after the official launch of the service. | ||
* There needs to be a counter of each article. | |||
* There needs to be a list of pages using it with a counter of queries per week. | |||
* There needs to be a possibility to block pages from using it. | |||
=== Nice To Have === | === P2 - Nice To Have === | ||
The platform would benefit from these features but they are not required for the daily usage of it. | The platform would benefit from these features but they are not required for the daily usage of it. | ||
* A webmaster can fetch a section of a SUMO article querying the API with the Title of the article and the name of the anchor. | |||
=== Unprioritized features === | === Unprioritized features === | ||