From 6b6e78cc722f21b1049fa5b6915e316e689556f8 Mon Sep 17 00:00:00 2001 From: Ed Morley Date: Thu, 14 Jan 2016 17:05:14 +0000 Subject: [PATCH] Bug 1239428 - Docs: Clarify process for API credential approval * Recommend using the same `client_id` for stage/prod. * Mention the need to file a bug (and where) for requesting approval. * Explain prod approval needs submission to be working on stage first. --- docs/common_tasks.rst | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/common_tasks.rst b/docs/common_tasks.rst index e3e457326..4138722e8 100644 --- a/docs/common_tasks.rst +++ b/docs/common_tasks.rst @@ -83,12 +83,20 @@ The generated Hawk ``secret`` will be output to the console, which should then be passed along with the chosen ``client_id`` to the TreeherderClient constructor. For more details see the :doc:`submitting_data` section. -Users can request credentials for the deployed Mozilla Treeherder instances +Users can generate credentials for the deployed Mozilla Treeherder instances (and view/delete existing ones) using the forms here: `stage `__ / `production `__. +It is recommended that the same ``client_id`` string be used for both stage +and production. -Once requested these require approval by a Treeherder administrator, here: +The credentials must be marked as approved by a Treeherder admin before they can +be used for submitting to the API. Request this for stage first, by filing a bug in +`Treeherder: API `__. +Once any submission issues are resolved on stage, file a new bug requesting +approval for production. + +Treeherder administrators can manage credentials here: `stage `__ / `production `__.