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

346 Коммитов

Автор SHA1 Сообщение Дата
Will Kahn-Greene 085cc3a7e6 Add note about engine=innodb to migration docs 2012-07-24 19:52:16 -04:00
Will Kahn-Greene 51697e0461 Docs updates
* Splits the docs into three sections---trying to reduce the "omg!
  there are a million sections!" overwhelming feeling
* Moves the test-related things to the tests chapter so they're all
  in one place
* Turned "coding" into "conventions"---that's what it really is.
* Fleshed out the git commit message conventions---it keeps coming up
  and we pointed to a guide which pointed to a guide and the links
  were buried in both places.
2012-07-17 21:46:45 -04:00
Will Kahn-Greene 5a14cd7d4d Fix python26 references
We no longer need that python26 goofy stuff since we ditched Sphinx.
2012-07-13 14:06:25 -04:00
Rehan Dalal 508bb8ffde [bug 770493] Enable LESS support 2012-07-05 11:35:22 -04:00
Cesar Carruitero fb124f7942 in docs: correct mysql sentence and add same convention for database password 2012-07-05 09:35:08 -04:00
Ricky Rosario ced4a3141a [bug 765816] Move Army of Awesome common replies to KB.
* Replies are now defined in KB article with slug
  'army-of-awesome-common-replies'.
2012-06-26 11:23:53 -04:00
Will Kahn-Greene 05c2e724be Update search docs
After talking with Matt, we decided to use the terms "regular" and
"advanced" for searches. This updates the documentation accordingly
and also cleans up some of the other text.
2012-06-25 20:24:13 -04:00
Will Kahn-Greene cb90635b2e Add links to expand on how scoring works
Understanding how scoring works makes it easier for us to craft articles
that get ranked appropriately. Links to such information is super duper.
2012-06-22 17:49:25 -04:00
Will Kahn-Greene 0f51168c49 Add docs on unified search results 2012-06-22 13:52:55 -04:00
Will Kahn-Greene f88e784a16 Re-add weight docs
This adds documentation for the weights we're currently using.
2012-06-22 13:49:30 -04:00
Cesar Carruitero 2f995d4f60 some bugs in install docs 2012-06-22 07:52:37 -04:00
Will Kahn-Greene ecf3549fe9 Fix section on git conventions
The docs should point to the Webdev Bootcamp guide for git conventions
and explicitly mention git commit message conventions.
2012-06-22 07:23:50 -04:00
Berker Peksag 768f0b4df7 Update MySQL commands in installation docs
to fix |Access denied for user ''@'localhost' to database 'kitsune'| error.
2012-06-22 07:17:42 -04:00
Will Kahn-Greene 8405999034 [bug 755923] RIP Sphinx
This removes all the Sphinx-related stuff.

You may need to do:

    git rm --cached vendors/src/oedipus vendor/src/sphinxapi

to remove the vendor git submodule stuff.
2012-06-21 13:19:46 -04:00
Ricky Rosario ce788faa3f [bug 686160] Update schema.sql and clear out migrations.
Updated docs to remove note about migration 109.
2012-06-08 18:26:48 -04:00
Ricky Rosario e90fe2c5a8 Added Army of Awesome chapter. 2012-06-08 16:59:23 -04:00
Ricky Rosario 86188bf664 Update wikidocs.rst.
Point to article in SUMO for list of important documents.
2012-06-08 16:14:23 -04:00
Rehan Dalal 0c51aa7847 [bug 752893] Verify minimal install docs 2012-06-06 18:21:06 -04:00
Will Kahn-Greene 1a6dafe74d Tweak docs for ES settings for devs
"sumo_dev" is a little clearer than "sumo" since it implies it's an
index for a dev environment.
2012-06-05 14:45:05 -04:00
Will Kahn-Greene 0397047b3c [bug 755926] Add non-destructive indexing
* add --delete to reindex cmd: By default, it **won't** wipe the index.
  It now only wipes and rebuilds the index from scratch if you tell it to.

* add note about fixing Redis scoreboard to the docs: If you're doing dev
  work and you purge the celery tasks, you also need to reset the Redis
  scoreboard that keeps track of outstanding tasks.  This adds docs for that.

* add delete-then-index to admin: This reworks the reindex section so that
  it has a "delete-then-index" button and makes it clearer which button
  does what and why you'd use it.

* adds the DANGER style to admin page.
2012-06-04 12:46:05 -04:00
Will Kahn-Greene bb8348f19b [bug 720935] Parallelize indexing
* reworks indexing to be parallelized when run from the admin
* changes the admin/search page to show outstanding tasks
* removes all the old progress-y stuff
* fixes the --checkindex flag for esstatus
* adds note to the ES documentation about purging celery--that's super
  helpful
2012-06-01 08:23:46 -04:00
Will Kahn-Greene 9da271c806 Fix docs to represent reality
Since the weights weren't actually being applied since they were specified
wrong, I removed them a couple of commits ago.

Given that, I'm updating the docs to reflect that.
2012-05-16 17:03:35 -04:00
Berker Peksag 1603b6db13 Update Bugzilla link: support.mozilla.com -> support.mozilla.org 2012-05-10 09:45:53 -04:00
Will Kahn-Greene e404c218a8 First pass at better contributor docs
* fixed some typos
* add hacking howto, contact us, and contributor docs
* added an AUTHORS file

The hacking howto probably doesn't work, but it's close. It needs someone
to go through it and fix issues in the docs and in the code to make it
work better.
2012-05-08 13:18:08 -04:00
Will Kahn-Greene 69de5a9418 Update deployment docs 2012-04-12 11:19:09 -04:00
Will Kahn-Greene d3f61ee215 Add SLA
This adds a rough SLA to the docs so we have something to point to when
making architectural decisions.

This SLA will change going forward.
2012-04-06 10:46:40 -04:00
Will Kahn-Greene 9013c42ed7 Update docs
This updates a bunch of minor things in the docs and adds links to
other things.
2012-04-02 18:18:46 -04:00
Will Kahn-Greene 1da75b46c8 Add note about preferring git:// over http:// 2012-03-19 09:49:48 -04:00
Will Kahn-Greene 7a2aa039d2 Make recommended changes from Ricky; fix wrapping
* Ricky suggested using schematic to tell us the version number
  rather than hit the database for it.
* Ricky suggested adding a note for making sure to insert the
  content type and default permissions for new models.
* Then I went through and fixed the wrapping for a bunch of
  lines
2012-03-19 09:43:36 -04:00
Will Kahn-Greene 5f74ef7d59 Add reindexing and migration change docs
This isn't great documentation, but it gets us started in making them
better.
2012-03-19 09:43:36 -04:00
Ricky Rosario 2faae1501d [bug 724849] Implement read/write index separation
* Splits searching and indexing so they use different index
  settings.
* Rename eswhazzup to esstatus and make it more useful.
* Make search admin more useful so it's easier to spot problems.
* Updates eswhazzup to be more useful and nixes the cluster status
* Add x per 1000 documents calculations to reindexing output.
* Fixes wiki document indexing so that when doing a reindexing, we're
  not calling unindex for things.
* Add esdelete command.
* Cleans up some code to make it more obvious and less errory.
* Update documentation.
* Update default settings.
2012-02-14 17:03:21 -05:00
Will Kahn-Greene 39ca9c0d2e Copyright updates 2012-02-08 09:45:28 -05:00
Will Kahn-Greene 1afcc2fc91 [bug 721411] Document search scoring
This adds documentation for search scoring as it's currently implemented.
Additionally, it adds some minor notes about where the ES-related code is
and links to the search view where the filters are.

Also adds a link to elasticsearch-head.
2012-02-07 10:43:12 -05:00
Will Kahn-Greene d477bb7436 Documentation updates
* update the docs regarding hudson -> jenkins naming of the irc bot
* add note about model makers to coding docs
* fixed a header (cosmetic)
* I added the email/name setting to the quick section since if you miss
  this step (which is not unlikely for new contributors), you have
  to do some fancy footwork to fix the commits you've made.
2012-02-06 18:29:37 -05:00
Will Kahn-Greene b24ba97ca9 Remove doctype-specific search docs
We no longer allow you to reindex by doctype, so we should remove that
documentation.
2012-02-06 17:18:16 -05:00
Will Kahn-Greene 57f4faf507 [bug 718826, 715932] Make ES indexing less sucky
* the ES connection already has code for forcing bulk, so we don't need to
  repeat that. this changes the code to push the setting to ES.
* this also tweaks the estimation code so that it shows minutes and seconds and
  shows the total delta later. Now I can stop running
  "time ./manage.py esreindex".
* fix esreindex so that you can specify doctypes. This will appropriately
  create/delete indexes so that what you don't want to delete won't get
  deleted.
* adds basic handling for bad data.

  This does a log.exception, but we really should log more than that and/or
  make it more obvious to developers that there's bad data out there.

  In the meantime, this allows us to continue indexing.
* reduced memory usage of indexing by iterating over ids---now it runs on
  my laptop.
* ghanges _get_index() to get_es_index(). We use it so often it might as
  well be part of the "public API".
* fixed create/delete indexes so that to switch doctypes to their own index
  is now just a change in settings---no code changes needed.
* fix DEBUG = True case by reseting queries
* this also adds a bunch of helpful comments, moves reindex_model to
  SearchMixin.index_all, and has some other cosmetic code cleanup.

End result of this is that indexing doesn't die if it hits bad data, indexing
takes much less memory to run, you can specify specific doctypes to index at
the command line, and the code is better.
2012-01-18 15:25:53 -05:00
Will Kahn-Greene 3ad809e2fe Adds default value docs for ES settings 2012-01-17 16:39:19 -05:00
Ricky Rosario 1aecf2ae7c Fixed submodules script and related docs. 2012-01-13 09:47:43 -05:00
Will Kahn-Greene 4a0130c0c9 [bug 709080] Refactor ES code into SearchMixin
This reduces the triplification of everything in es_search modules.
This reduces the triplification of everything in es_search modules.
This reduces the triplification of everything in es_search modules.

Also, I introduced ES_INDEXING_TIMEOUT, fixed documentation, and
cleaned up some other things while I was poking around.

Also also, I nixed all the ES mapping constants. Calling put_mapping
with typos will kick up an error, so there's no need to additionally
have constants around to prevent typos.
2012-01-11 12:54:43 -05:00
Will Kahn-Greene 7b0827729d [bug 690086] tweak vendor.rst language
This tweaks the language to make it clearer that the vendor stuff
is in the kitsune repository and not a separate one.

It also turns a caveat thing into a warning so it shows up better.
2011-12-13 17:37:46 -05:00
Will Kahn-Greene f8a40eec92 [bug 710279] Fix test_creator_nums_redis test
KarmaManager() gets created before we stomp on the REDIS_BACKENDS settings
with REDIS_TEST_BACKENDS.  This switches all that testy stuff around to use
settings_test.py which stomps on everything before modules get imported.
2011-12-13 15:23:46 -05:00
Erik Rose 40205e12be [bug 694979] [bug 698474] [bug 698475] [bug 706638] Add optional, experimental support for ElasticSearch.
The advanced search works, but the front-page search and the searching from within the questions app are still buggy (returning 0 results). Thus, we'll leave the waffle flags off for now.
2011-12-09 13:57:09 -05:00
Will Kahn-Greene 46631ef86f Fix indexing so it does it in order by id
This makes my 5% much closer to Erik's 5% so it's easier to do development
and compare notes when indexing only a percentage of the db.
2011-12-09 12:01:19 -05:00
Will Kahn-Greene e66195ccb0 Add note about other Elastic Utils settings 2011-12-09 10:34:44 -05:00
Will Kahn-Greene fb9612fcfc Add mediocre docs for USE_ELASTIC and waffle flag 2011-12-09 10:28:25 -05:00
Will Kahn-Greene 3857e5c879 Add docs for --percent 2011-12-09 10:21:07 -05:00
Ricky Rosario 5ebc3053e2 Updated docs
* s/jsocol/mozilla/
* Updated stage and dev urls
2011-12-07 16:29:55 -05:00
Berker Peksag e13f9c2afc Add good initial dev settings to docs. 2011-12-01 18:08:44 -05:00
Will Kahn-Greene e5e775963a Use settings_test rather than depend on env var
Instead of using DJANGO_ENVIRONMENT environment variable, we put the
settings for indexes for Elastic in settings_test.py.
2011-11-30 19:37:09 -05:00
Will Kahn-Greene f7f5bf5a2f Incremental question update and fixes
* unhardcodes indexes
* ditches ElasticMeta--elasticutils uses Model._meta.db_table for
  queries, so we should use that for building indexes, too
* implements incremental updates for Question and adds test
* adds some test harness code for future elastic tests
* adds basic docs for setting up Elastic
2011-11-28 11:46:53 -05:00
James Socol cac71e3c9b Update docs/installation.rst to reference vendor.rst. 2011-11-07 18:47:19 -05:00
James Socol d33e4ce208 Update docs/vendor.rst. 2011-11-07 17:38:47 -05:00
Will Kahn-Greene b3e1202f75 Renames search chapter filename
"search" is used for the quick search page, so having a chapter with
the filename "search.rst" is problematic.
2011-10-04 16:20:16 -04:00
Will Kahn-Greene 251162c73e Fixes references 2011-10-04 16:18:31 -04:00
James Socol 676f9b9a22 Update L10n documentation. 2011-10-03 15:24:53 -04:00
Ricky Rosario 269fa5410e [bug 678276] karma titles l10n
* Added extract_db management command for generically handling db content.
* Updated docs to explain how it works.
2011-09-21 16:55:49 -04:00
Will Kahn-Greene 7e5f7fe0dc Adds redis configuration and run docs 2011-09-10 16:29:29 -07:00
Will Kahn-Greene 340ff3e318 Creates sphinx-docs files
This makes it easier to build the documentation into a manual.  This
also makes it easier to search, add indexes to, ...
2011-09-10 16:28:50 -07:00
James Socol 380690befc Document servers and deployments. 2011-08-26 12:09:16 -04:00
James Socol 39e05f6c7a Document IRC bots. 2011-08-26 12:09:15 -04:00
James Socol 72ee4ae19a Document submitting a patch. 2011-08-26 12:09:15 -04:00
Tanay Gavankar 05e3d844ac [Bug 663241] KB Helpfulvotes Metrics Frontend Graphing 2011-07-26 19:53:02 -04:00
Erik Rose 02592023e4 Update docs for vendor library merge.
Meant to do this in previous commit.
2011-07-18 12:08:39 -07:00
Erik Rose 792a015f5a Move the product_details initialization before the test run.
At least one test (question auto-tagging) fails otherwise.
2011-05-17 11:18:13 -07:00
Ricky Rosario 1b03a4de54 Integrated QUnit via django-qunit. Let the js testing begin! [bug 638856] 2011-03-08 17:24:32 -05:00
James Socol 80f1ca98d4 Make the vendor lib a submodule. [bug 637313] 2011-03-01 18:10:47 -05:00
James Socol 10ce7716d8 Add schema and update installation docs. [bug 634677] 2011-02-28 09:45:27 -05:00
James Socol ab2ead5914 Fix error in l10n docs. 2011-01-28 15:27:20 -05:00
James Socol 5610b1e09e Add tests.rst about the test suite. 2011-01-28 15:27:20 -05:00
James Socol 7bf2d68ca1 Add a note about TEST_CHARSET and TEST_COLLATION to installation.rst 2011-01-28 15:27:19 -05:00
James Socol 24646f961b Add celery.rst to get celery up and running. 2011-01-28 15:27:19 -05:00
James Socol eb238feb65 Adding email.rst to get email set up. 2011-01-28 15:27:19 -05:00
James Socol 10a63e5641 Update wsgi.rst with debugging and apache modules. 2011-01-28 15:27:18 -05:00
James Socol 8a089fdb8f Clean up coding.rst 2011-01-21 17:54:13 -05:00
James Socol f3a36ae908 Add search docs and some helpful management commands. 2011-01-21 17:54:13 -05:00
James Socol 1d9bb3f592 production.rst is really redundant right now. 2011-01-21 17:54:13 -05:00
James Socol e4e6f65469 Short update to wsgi.rst. 2011-01-21 17:54:13 -05:00
James Socol c5744feae9 Updating Vendor lib docs. 2011-01-21 17:54:12 -05:00
James Socol e353583fa2 Rewrite installation.rst 2011-01-21 17:54:05 -05:00
James Socol ff0babf119 Remove locale submodule and add docs. [bug 625755] 2011-01-15 12:34:24 -05:00
Erik Rose a814221dea [bug 610527] Implement very tolerant fetching and storing of WebTrends stats. Expose a cron job for refreshing them. Also...
* Valign table headers to the bottom and table data to the middle.
* Add a test for number() Jinja function.
2011-01-11 17:08:34 -08:00
Paul Craciunoiu b51d8b5cee [613329] Videos can link to CDN if setting provided. 2010-11-19 16:31:41 -08:00
Paul Craciunoiu e664ef5c3d [600747] Video hook and render with Flash fallback.
* Videos are identified by title and locale
* Depends on an update in py-wikimarkup which adds support for <video> and <source> tags (py-wikimarkup commit cc06e6d264622891b6b018e8670c9ef4bb12d618)
* Attaches all the _hook_*s to the WikiParser class, because they need a contextual locale.
* Adds locale support for any of the hooks that do document lookup.
* Uses SWFobject JS lib to support flash fallback for video.
* Adds a migration for unique ('locale', 'title') on gallery_video and gallery_image
* Adds a WIKI_VIDEO_WIDTH|HEIGHT constant that may be used as MAX_WIDTH|HEIGHT in the future, once we get video thumbnails.
2010-10-07 15:07:19 -07:00
Paul Craciunoiu 57f3f568f5 [592674] Media gallery uploads backend
* Raise FixtureMissingError in test helpers, e.g. on creating media gallery image and wiki revision, instead of creating testuser
* Add ImageUploadForm and VideoUploadForm
* Simplify gallery app's urls.py
* Adds a bunch of gallery utils to create and upload media
* Adds two views up_media_async, del_media_async
* Rename upload_images to upload_imageattachments
* Define a more generic upload_media function to be used by the gallery app
* Document some of our coding conventions
* Add a migration for the video model
* Define a MAX_FILESIZE for video uploads (16 megabytes), overwritable in settings_local.py
2010-09-15 15:23:58 -07:00
Paul Craciunoiu 28061e093f [592670] Media gallery models: a gallery app
Includes:
* migrations for the models
* a shared abstract model Media for the concrete Image and Video models
* restricting locale choices in the gallery and wiki models
* some check.py complaints and cleanup
* a documentation section for production regarding upload paths
2010-09-07 13:16:21 -07:00
James Socol fd125cb2a6 Add a vendor.rst doc. 2010-08-24 18:50:18 -04:00
Erik Rose 33a983de84 [587219] Move the update_product_details step below the DB setup in install docs. 2010-08-13 16:57:48 -07:00
James Socol d98bcd5c9a [bug 584543] Removing the remaining traces of Hunspell and DidYouMean. 2010-08-05 12:28:48 -04:00
Erik Rose afaac7af31 [581108, 581584] Implement auto-tagging based on product, category, OS, and FF version. Drop "Intel" and "PPC" from Mac OS names.
* Tags are added for full and tenths-place variants (e.g., 4.0.1 and 4.0) of known Firefox versions.
* An OS will be auto-tagged if there exists a tag with its name (case insensitive). (I posit ease of administration outweighs risk of abuse.)
* Finished off questions_config based on Cww's etherpad.
* Show user agent string in System Details pop-up.
2010-07-29 10:56:36 -07:00
Paul Craciunoiu 08f2586e91 [578520] Move thumbnail generation to a celery task. Create macros for attachments and add them to the reply and edit forms. 2010-07-28 14:13:30 -07:00
James Socol fe5b63f466 Updating production docs to include the BROKER_* and CELERY_* settings. 2010-06-01 22:30:28 -07:00
Joshua Gross ccd30049ac Change CACHE_BACKEND to use pylibmc (bug 567181) 2010-05-21 11:17:13 -07:00
James Socol 910d301d06 Add submodule update step to installation docs. 2010-05-04 15:47:36 -07:00
James Socol f0f2e6e427 Adding a production document. 2010-04-20 18:26:09 -07:00
James Socol 79847afa23 Production documents. 2010-04-20 18:25:58 -07:00
James Socol a088ac5435 Added installation.rst 2010-02-03 16:44:31 -08:00