Граф коммитов

190 Коммитов

Автор SHA1 Сообщение Дата
Jonathan French 3397407dba Bug 1302754 - Update the docs copyright (#1852)
* Update the docs copyright to 2016
* Add "other contributors"
2016-09-14 11:30:37 -04:00
Ed Morley 1b4010f728 Bug 1297666 - Remove supervisord configs/documentation
Since it's a non-default workflow that isn't kept up to date, and is
going to be even less relevant once we switch to tooling that uses the
Procfile.
2016-08-26 15:56:53 +01:00
Ed Morley 3129b6249d Docs: Update Vagrant command examples to use current shell prompt 2016-08-19 16:06:41 +01:00
Ed Morley c9470ac83d Bug 1289709 - Docs: Simplify development data ingestion instructions
Now that Treeherder's data ingestion process doesn't hit it's own API:
* `./manage.py runserver` is less susceptible to memory issues.
* The runserver/gunicorn process doesn't need to be running whilst the
data ingestion takes place.
2016-07-30 13:11:58 +01:00
Andy McKay 55dff0175c docs: make client the name of the module (#1720) 2016-07-27 16:15:31 -04:00
camd 93efadb189 Bug 1286939 - Instructions for registering a Pulse Job Exchange (#1690) 2016-07-21 13:21:04 -07:00
ka7 bfc5076e5a minor spelling fixes (#1686) rs=emorley 2016-07-13 21:29:58 +01:00
William Lachance d884754b76 Docs: Fixes for code example in data validation section (#1684) 2016-07-13 15:45:06 -04:00
Ed Morley b60b90097e Bug 1286240 - Docs: Install 'wheel' at the same time as 'twine'
Since if the wheel package is not installed, it results in:
`error: invalid command 'bdist_wheel'`
2016-07-12 15:20:17 +01:00
Ed Morley 1ede6b0a33 Bug 1284853 - Simplify the create_credentials command
Since it's only used for local testing, so there's no need to populate
description or set an owner. (They can always be added afterwards via
the Django admin UI).

Prior to this the command would fail if the provided owner email address
did not correspond to a valid user, which meant the added hassle of
creating a user prior, if one did not already exist.
2016-07-07 23:29:42 +01:00
camd c183a7abeb Bug 1266229 - Pulse doc fix for link to YML (#1656) 2016-07-06 16:19:00 -07:00
Ed Morley e253ddec3d Bug 1284503 - Docs: List the error message shown for Hawk token expiry (#1648)
To make it clearer when submitters are hitting this case vs other
authentication failure modes (like incorrect `client_id` or `secret`).
2016-07-05 21:52:39 +01:00
Ed Morley 8c1e8f9fcc Bug 1284460 - Docs: State bugs should be filed for credential changes
To ease debugging and coordinating with credential owners in case of
any later issues.
2016-07-05 13:18:10 +01:00
Ed Morley 6001db3761 Bug 1279213 - Python client: Combine host and protocol into server_url
This makes it harder to inadvertently use HTTPS with local Vagrant
hostnames, as well as reduces the number of config variables users of
the client have to keep track of.

The docs have been tweaked to encourage people using production
Treeherder to just omit the `server_url` argument entirely, which
reduces the boilerplate, and also means they'll be less affected by
changes in the future.
2016-06-23 09:47:46 +01:00
KWierso 8fcad12483 Bug 1280185 - Mention npm install earlier in the UI docs (#1590) r=emorley 2016-06-15 14:15:27 +01:00
Cameron Dawson 3402f00fbc Bug 1266229 - Create store_pulse_jobs queue and prep to turn on Pulse ingestion
Rename ``ingest_from_pulse`` management command to ``read_pulse_jobs`` to
indicate that this step does not actually do any ingesting.  It just populates
the celery queue ``store_pulse_jobs`` that DOES do the actual ingesting.
2016-06-01 16:31:14 -07:00
William Lachance 7c7c2013de Emphasize importance of vagrant provision finishing in docs 2016-05-31 15:44:52 -04:00
William Lachance 3cbd1cb34b Move note about nfs-kernel-server on linux
From troubleshooting to the installation section, more obvious this way
(based on changes by Armen Zambrano <armenzg@mozilla.com>)
2016-05-31 15:43:48 -04:00
William Lachance 7cfc022a5b Add autobuild target for docs makefile
Based on work by Armen Zambrano <armenzg@mozilla.com>
2016-05-31 15:34:26 -04:00
Ed Morley 641ef6a8e2 Bug 1269715 - Docs: Add steps for releasing a new Python client version 2016-05-30 15:19:19 +01:00
Ed Morley c43ec94f03 Bug 1229025 - Docs: Add logging setup steps for the Python Client
Since several people have not had logging set up when trying to debug
issues using the client/API, so instead of a helpful error message (eg
reminding them to sync their clock for Hawk auth), they get:
`No handlers could be found for logger "thclient.client"`
2016-05-30 14:05:12 +01:00
Ed Morley d5680e9796 Bug 1229025 - Docs: Capitalisation fixes 2016-05-30 13:54:16 +01:00
Ed Morley 3ed821a01b Bug 1229025 - Docs: Fix the link to the Python Client section 2016-05-30 13:53:44 +01:00
Ed Morley c5a0513413 Bug 1267683 - Docs: Describe the upcoming User Agent requirements
We're soon going to start blacklisting some default scripting User
Agents, to try and make accidental API abuse easier to trace back to the
source.

The docs are being updated in advance, so that the newsgroup posts have
the real pages available to link to.
2016-05-30 12:32:03 +01:00
Ed Morley f93329bb7b Bug 1267683 - Docs: Move 'managing API credentials' under 'REST API'
To make the content easier to find, and reduce the size of the generic
'common tasks' section.
2016-05-30 12:11:30 +01:00
Ed Morley f66cd6db93 Bug 1267683 - Docs: Move authentication section under 'REST API'
Since in the future we'll be adding rate limiting for all API requests
and as such authentication is not specific to just data submissions.
2016-05-30 12:11:30 +01:00
Ed Morley c49e695390 Bug 1267683 - Docs: Move Python client section under 'REST API' 2016-05-30 12:11:30 +01:00
Ed Morley decf573e9f Bug 1267683 - Docs: Add a generic API section
For content that's not specifically related to only one of submitting or
retrieving data from the Treeherder API, to avoid duplication.

Ideally the submitting/retrieving sections would be nested under this
new REST API section, however there isn't a way to get Sphinx to do this
that doesn't then mis-display the subheadings:
http://stackoverflow.com/questions/25276415/prevent-sub-section-nesting-in-python-sphinx-when-using-toctree
2016-05-30 12:11:30 +01:00
Ed Morley bc48151720 Bug 1272207 - Docs: Update instructions for syncing npm-shrinkwrap.json
Since npm 3 (which ships with nodejs 5+) fixes many of the previous
issues, making the third-party npm-shrinkwrap tool redundant (the tool
is also not compatible with npm 3).
2016-05-26 15:47:12 +01:00
crosscent 5053a342f0 Bug 1274054 - Don't require a local.conf.js for local development 2016-05-20 08:32:29 -04:00
Jonathan French 88ea1aee20 Bug 1272049 - Generalize vagrant and vbox install requirements 2016-05-11 14:24:02 -04:00
William Lachance cf39f8b530 Bug 1216113 - Enable django debug toolbar in vagrant 2016-05-05 18:02:24 -04:00
Ed Morley 7dac747d5b Bug 1270239 - Docs: Remove the redundant sphinx_rtd_theme workaround
The workaround that allowed using sphinx_rtd_theme when building
locally, is no longer required. See:
https://github.com/rtfd/readthedocs.org/pull/2115
2016-05-04 20:31:50 +01:00
Ed Morley f9e3f57ed5 Bug 1270236 - Update ReadtheDocs links to the new .io domain
To save the hitting the newly added redirect from .org to .io.
2016-05-04 20:30:23 +01:00
William Lachance f44cd1c6ea Bug 1265829 - Clarify documentation around managing API credentials 2016-04-19 14:30:50 -04:00
Shing Lyu 8f14d9f206 Fixed typos in submitting data doc 2016-04-13 14:36:16 -04:00
Cameron Dawson 2a9dbefa49 Bug 1199364 - Use revsion instead of revision_hash for resultsets
New resultsets will still store a value in their ``revision_hash`` field, but it will
just be the same value as their ``long_revision`` field.

This will log an exception in New Relic when a new resultset or job is posted
to the API with only a ``revision_hash``and not a ``revision`` value.

This also switches to using the longer 40 char revisions along side the
12 char revisions.  But we leverage the longer ones for most actions.  The
short revisions are stored and used so that people and the UI can support
locating a resultset (or setting ranges) with short revisions.
2016-03-17 15:48:49 -07:00
James Graham 4cfe414d22 Bug 1255087 - Remove store_pulse_jobs Queue that is not used in production. 2016-03-16 17:46:16 +00:00
Ed Morley e13ed57593 Bug 1244142 - Vagrant: Remove support for creating a 'scratch' VM
Vagrant now supports a snapshots feature which makes this obsolete:
https://www.vagrantup.com/docs/cli/snapshot.html

By removing the 'scratch' Vm config, we avoid confusion console messages
when performing Vagrant commands, eg:

[~/src/treeherder]$ vagrant provision
==> default: Running provisioner: puppet...
...
==> default: Notice: Finished catalog run in 14.75 seconds
==> scratch: VM not created. Moving on...
2016-01-29 16:01:16 +00:00
Ed Morley 6b6e78cc72 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.
2016-01-14 17:05:14 +00:00
William Lachance 6810ed9758 minor doc improvement for client-side installation
link directly to bugzilla for a link
2016-01-08 13:44:05 -05:00
Ed Morley 39d572d952 Bug 1230179 - Docs: Fix the links to Swagger so they don't 301 redirect
Avoids this redirect seen in prod gunicorn logs:

[05/Jan/2016:05:55:42 -0800] "GET /docs HTTP/1.1" 301 -
"http://treeherder.readthedocs.org/retrieving_data.html"
"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.10; rv:46.0) Gecko/20100101 Firefox/46.0"
2016-01-06 16:44:29 +00:00
William Lachance bce0bef92e Bug 1231421 - Add hint about UI-only treeherder to installation docs 2015-12-09 17:10:36 -05:00
William Lachance 1c25789c10 Update docs title 2015-12-09 11:02:55 -05:00
Ed Morley 5f9a57ef21 Bug 1225597 - Docs: Use anonymous links to avoid build warnings
Fixes:
common_tasks.rst:2: WARNING: Duplicate explicit target name: "stage".
common_tasks.rst:2: WARNING: Duplicate explicit target name: "production".

http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#anonymous-hyperlinks
2015-11-25 13:35:25 +00:00
Ed Morley 6df3aa4ac3 Bug 1225597 - Docs: Make local hawk credentials section easier to find
Also remove the duplication between the two pages, by having the
submitting data section not mention requesting credentials at all, and
leave that to the common tasks page instead.
2015-11-25 13:35:25 +00:00
Ed Morley ed8498710c Bug 1221536 - Docs: Emphasise starting the worker before ingest_push
If the worker is not running, any `apply_async()` calls are silently
thrown away, due to `ingest_push`'s use of `CELERY_ALWAYS_EAGER` and:
https://github.com/celery/celery/issues/2910

As such, running the worker after ingest_push doesn't help (since the
rabbitmq queues are empty) and so if people are interested in perf/log
data, then they must start the worker first instead.
2015-11-04 16:18:14 +00:00
Ed Morley f059f88d85 Bug 1205758 - Run `grunt build` as part of the stage/prod deploy
In update.py, the line outputting revision.txt has to be moved later,
since the `dist/` directory won't exist until grunt build has run. In
addition, since `grunt build` removes the entire `dist/` directory, we
no longer need to manually remove *.gz.

We use the `--production` options for both `npm install` and
`grunt build`, so that the `devDependencies` in package.json are
ignored, and we only install/load the ones listed under `dependencies`
in package.json - since that's all that is required for the build.

We have to use `./node_modules/.bin/grunt` rather than `grunt`, since
grunt-cli is not installed globally on the treeherder admin machine for
greater isolation between stage and production.
2015-10-31 16:06:08 +00:00
Ed Morley 27941c32d9 Bug 1206381 - Add npm-shrinkwrap.json to pin grunt build dependencies
Whilst the packages listed in package.json are pinned to exact versions,
they will have their own dependencies, which may be specified via
version ranges. In order to make production/local behaviour more
deterministic, these can be pinned too, using `npm shrinkwrap`.
However the stock shrinkwrap command has a few deficiencies, so we're
using a wrapper around it:
https://github.com/uber/npm-shrinkwrap

Note: Only packages listed under `dependencies` will be shrinkwrapped,
not those under `devDependencies`. This is because using the `--dev`
option (which would include the dev packages in npm-shrinkwrap.json)
means there would then be no way to way to exclude the dev packages when
installing in production.

For more information about shrinkwrap in general, see:
https://docs.npmjs.com/cli/shrinkwrap
http://tilomitra.com/why-you-should-use-npm-shrinkwrap/
https://nodejs.org/en/blog/npm/managing-node-js-dependencies-with-shrinkwrap/
2015-10-28 09:33:17 +00:00
Mauro Doglio c876849a3c Bug 1193836 - Remove mention to init_master_db from docs 2015-10-27 11:19:18 +00:00