mozilla
/
kitsune
зеркало из https://github.com/mozilla/kitsune.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
10 775 коммитов 18 Ветки 131 Тег 200 MiB
Граф коммитов

385 Коммитов

Автор SHA1 Сообщение Дата
Will Kahn-Greene 656b46c900 [bug 1194899] Document locales api 2015-10-14 09:12:49 -04:00
Will Kahn-Greene 629ed54980 Fix Sphinx build issues 2015-10-14 09:12:48 -04:00
Will Kahn-Greene 857729aa66 Add Pygments and sphinxcontrib-httpdomain 
* need Pygments for Sphinx to work at all
* adding sphinxcontrib-httpdomain to make documenting APIs easier
 2015-10-14 09:12:48 -04:00
Will Kahn-Greene 8db5fc9682 [bug 1204627] Remove old language-picker test 
* removes the old language-picker test
* removes selenium and liveservertestcase infrastructure
 2015-09-29 11:22:39 -04:00
Mike Cooper 9317205d96 [Bug 1203633] Switch to Mocha for JS tests. 2015-09-11 16:06:45 -07:00
Mike Cooper adde3c81e3 Merge pull request #2480 from safwanrahman/patch-19 
Add separate section for Vagrant and updating the instruction
 2015-05-26 13:18:25 -07:00
Will Kahn-Greene f48116bf87 [bug 1164565] Fix document results in search suggest API 
This switches document results to use DocumentDetailSerializer. It also
fixes DocumentDetailSerializer to include the document summary which is
on the current revision and the document url.
 2015-05-13 15:41:52 -04:00
Will Kahn-Greene d1e3f6ff33 [bug 1164205] Added api docs for search suggest api 
I have no idea if this is the format we want to go with, but it is some
documentation.

Maintaining it will be painful. It's probably better for us to figure
out a way to autogenerate the documentation or somehow move the
documentation to the code. That work is covered in bug #1164247.
 2015-05-13 10:29:28 -04:00
Safwan Rahman 369bf12eed Add separate section for Vagrant and updating the instruction 2015-05-09 20:53:21 +06:00
Ricky Rosario cc39699978 Update docs for django 1.7 
Mostly migrations stuff.
 2015-04-27 08:55:16 -04:00
Will Kahn-Greene 558c2c7b70 Fix the peep.sh command line examples 2015-04-10 06:47:23 -07:00
Mike Cooper 63db1da144 Add docs for Pre-Commit to hacking-howto. 2015-04-09 20:04:46 -07:00
Mike Cooper 398c25215d Bring in peep.sh from fjord to deal with pip version incompatibilities. 2015-04-09 17:06:46 -07:00
Mike Cooper 282c44685a Merge pull request #2430 from mythmon/community-top-contributors 
[Bug 1139127,1139128,1143941,1143945] Community top contributors
 2015-04-01 11:13:46 -07:00
Mike Cooper 29089c14fa Merge branch 'pr/2435' 2015-03-30 14:01:00 -07:00
Ricky Rosario d07f5537a3 [bug 1145182] RIP test_utils 2015-03-30 09:45:01 -04:00
Will Kahn-Greene a1e720d478 [bug 1148082] Fix --no-skip 
nose has a skip plugin which enhances SkipTest raising beyond our
wildest imaginations. However, there are certain occasions where we want
skipped things to not skip with reckless abandon but instead don the
malevolent cloak of errorhood.

nose has a --no-skip argument for exactly this sort of sordid thing, but
it's totally busted and doesn't work.

This changes the code around so that it works correctly.
 2015-03-26 20:31:56 -04:00
Mike Cooper 31e60981b4 Feedback and tests. 2015-03-26 15:59:15 -07:00
Rehan Dalal 327e855555 [bug 1147861] Run tests without collecting static 2015-03-26 18:51:38 -04:00
Mike Cooper 62fbdd3767 Update docs to talk about new front end practices. 2015-03-25 14:52:02 -07:00
R&D 13acadd064 Merge pull request #2419 from rehandalal/npm-lockdown 
Use npm-lockdown to install Node dependencies
 2015-03-24 02:30:12 +05:30
Ricky Rosario 7da7834a40 Remove check.py recommendation in favor of pre-commit linter 2015-03-19 15:18:31 -04:00
Rehan Dalal b3a95766c3 more update docs 2015-03-17 18:03:44 -04:00
Rehan Dalal 65a570d1a7 Update docs 2015-03-17 18:03:44 -04:00
Safwan Rahman 663661a3c6 Updating the Doc by adding new requirments 2015-03-10 01:56:12 +06:00
Mike Cooper d7e1050d91 Merge pull request #2325 from mythmon/bgb 
Document git merge workflow.
 2015-01-27 14:13:03 -08:00
Mike Cooper 98d7bc504e Fix typo in PR policy. 2015-01-27 13:28:45 -08:00
Safwan Rahman b064e5449a Little Edit 2015-01-27 17:59:04 +06:00
Mike Cooper c13c41b7c7 Update docs for a merge based flow. 2015-01-26 15:19:02 -08:00
Mike Cooper bfab92a68f Remove 2.6 stuff. 2015-01-22 16:49:30 -08:00
Safwan Rahman bcc31d6f2e Adding Open SSL in requirments 
While installing Kitsune, following Library is needed.
* Open SSL Library named libssl
 2015-01-13 14:23:37 -08:00
Mike Cooper 256e2e0d5b Make settings_local easier. 2014-12-31 10:02:44 -08:00
Ricky Rosario 58ad020ed5 [bug 1097168] AAQ - Use about:support API when available. 2014-12-18 16:24:47 -05:00
Mike Cooper b44b4685b3 Add docs for adding new deps with peep. 2014-12-16 15:36:39 -08:00
Ricky Rosario 5c3326d3bd [bug 1097052] Remove most of the Karma app. 
Only Titles are left.
 2014-12-09 14:57:31 -05:00
Dean Johnson 0929579b58 [bug 905834] Vagrant support for dev deployment. 2014-12-05 13:38:33 -05:00
Dean Johnson 042a92ea1c Fixed js module binary paths for docs. 2014-11-25 21:58:16 -05:00
Mike Cooper ab46c1be73 Remove ACE submodule, just use the files. 
This is the last submodule!
 2014-11-18 23:12:27 -08:00
Ricky Rosario 814710971a [bug 1087638] Remove offline app. 
This was used by osumo which is not around anymore.
 2014-10-22 18:55:26 -04:00
Mike Cooper 3df48e6e23 [Bug 1074861] Add --no-use-wheel to docs and Travis. 
This is a partial cherry-pick of
a1b3203620. The difference is that it
doesn't change deployments.
 2014-10-13 07:56:06 -07:00
Mike Cooper 8f7a635582 Revert "[Bug 1074861] Add --no-use-wheel to peep deploys." 
Until Bug 1078389 is resolved.

This reverts commit a1b3203620.
 2014-10-06 10:24:59 -07:00
Mike Cooper a1b3203620 [Bug 1074861] Add --no-use-wheel to peep deploys. 2014-10-03 12:30:43 -07:00
Will Kahn-Greene b74b48e4be Fix docs typo 2014-09-22 18:24:01 -04:00
Will Kahn-Greene cc19bee084 Revert "Docs fix" 
Totally didn't mean to push this.

This reverts commit a41c5868eb.
 2014-09-22 18:22:45 -04:00
Will Kahn-Greene a41c5868eb Docs fix 2014-09-22 18:22:02 -04:00
dean 6ef130a25f [bug 1070035] Added python26 deps req file. 
It only contains importlib for now.
 2014-09-19 15:08:27 -07:00
Rehan Dalal 13ca694542 Update docs to include gulp info 2014-09-18 19:57:51 -04:00
dean ed15d1e961 [bug 1035319] Updated docs to swap vendor for peep. 2014-09-18 14:55:44 -07:00
Mike Cooper 04987977ef Change hacking howto to use a virtualenv. 2014-07-18 16:17:31 -07:00
Rehan Dalal 3c23133f5e Update docs to correct ES version 2014-06-16 05:34:55 -04:00
Ricky Rosario f557f47223 [bug 1013495] Stop showing archived questions in default search. 2014-06-06 15:38:19 -04:00
Ricky Rosario a7283e188f [bug 1007319] Switch to match and match_phrase queries. 2014-05-20 18:55:01 -04:00
Will Kahn-Greene 21cbc7711d Document comments for trans blocks 
This took me 30 minutes to find, so I figured I'd document it.
 2014-05-01 10:40:05 -04:00
Ricky Rosario a15f465d1c Fix vendor docs. 2014-04-02 17:25:33 -04:00
Ricky Rosario 93ca65a886 Add section to docs about removing submodules from vendor. 2014-03-19 12:15:14 -04:00
Ricky Rosario 1a59ed6cc4 [bug 971000] Protect login with django-axes. 2014-02-26 15:40:25 -05:00
Ricky Rosario f0e5737797 [bug 971089] Remove scripts for jenkins, jstestnetlib. Update bots docs. 2014-02-25 09:33:53 -05:00
Ricky Rosario f9153cddae [docs] Fix the name of the suite that runs on stage. 2014-01-22 16:20:59 -05:00
Will Kahn-Greene 583c578975 Fix generatedata 
* the hacking howto has instructions for creating the db that don't
  include setting the CHARSET so it would die on creating revisions
  using the revision model maker which includes unicode data
* the revision model maker code value strings were ... "interesting"
* cosmetic: i tweaked the formatting in the MozillaNews.wiki
 2013-11-13 09:11:56 -05:00
Kadir Topal 8151a05398 Addressing formatting and build issues. 2013-10-22 15:12:16 -04:00
Kadir Topal 036ef50f0e Fixed formatting and wording for threads status 2013-10-22 15:12:16 -04:00
Kadir Topal 44d00020ee Adding documenting for AAQ search and questions states 2013-10-22 15:12:16 -04:00
Will Kahn-Greene 8e39febda2 Tweak docs for reporting l10n errors 2013-10-21 15:32:19 -04:00
Will Kahn-Greene ba6e152737 Add docs for reporting errors in .po files 2013-10-17 10:25:49 -04:00
Will Kahn-Greene 30729e1a24 Tweak .less.css removal to be shell-generic 2013-10-17 09:12:55 -04:00
Will Kahn-Greene 34f54736ef [bug 902108] Add dennis v0.3.7 to vendor/ 
This updates polib and adds dennis to vendor/. Now we can do things
like:

    ./manage.py lint
    ./manage.py translate

Also, this nixes poxx.py and localelinter.py which aren't needed
anymore.
 2013-10-16 12:49:34 -04:00
Ricky Rosario 35984c271d Add age filter default for questions to the search docs. 2013-09-26 17:58:56 -04:00
Will Kahn-Greene d3ad5f7f69 Add SELENIUM_FIREFOX_PATH for sad-path environments 
I have Firefox Nightly earlier in my path than Firefox stable. Nightly
has problems with Selenium that haven't been fixed, yet, (or something
like that). This allows me to specify exactly which Firefox binary to
use without having to fiddle with my PATH environment variable which
caused other problems because of virtual environments and such.

It defaults to exactly what happened before, so if it worked for you
before, you should see no change with this change.
 2013-09-26 12:42:44 -04:00
Ricky Rosario 8f23727a9c [bug 912662] Document badge image requirements. 2013-09-13 11:34:02 -04:00
Ricky Rosario 63dbc54b4b Fixed missing link in docs. 2013-09-13 10:41:07 -04:00
Will Kahn-Greene cde04df1f1 [bug 911831] Update db and migration docs for South 2013-09-11 14:51:35 -04:00
Shuhao Wu cf8ccaa583 Added API for oSUMO. 2013-09-05 14:01:52 -07:00
Will Kahn-Greene 60464833f3 Update migration-building-related docs 2013-09-05 12:57:45 -04:00
Will Kahn-Greene 698a4d71ab Fix settings_local.py example import 2013-08-07 16:18:04 -04:00
Michał Frontczak 03e571f87c Tweak docs to specificy less version 1.4.1 2013-08-01 11:41:48 -04:00
Will Kahn-Greene 2bf219b930 Minor formatting fixes in docs 2013-07-31 13:13:37 -04:00
Kadir Topal 1a2e7b389a [Bug 898001] Create table of content for Kitsune admin documentation 2013-07-31 13:10:32 -04:00
Ricky Rosario dd7e9851f0 Update docs to reflect https URLs for repos. 2013-07-31 11:24:01 -04:00
Will Kahn-Greene 2a8bef4f6b Add dev-sumo mailing list to contactus 2013-07-18 13:59:52 -04:00
Will Kahn-Greene cea4a6dc1c Nix jsocol from the contactus list. :( 2013-07-18 13:57:00 -04:00
Will Kahn-Greene 78529aec5e Tweak docs to cover collectstatic/compress_assets 
Before running the LiveServerTestCase-based tests, we need to run:

    ./manage.py collectstatic
    ./manage.py compress_assets

This change attempts to clarify that in the test docs.
 2013-07-12 10:16:53 -04:00
Will Kahn-Greene 1397e9cf78 Update patching docs to what we actually do 2013-07-12 10:11:15 -04:00
Will Kahn-Greene ac0a58d041 Move reference to correct section 2013-07-09 17:29:28 -04:00
Will Kahn-Greene 5080447667 Fix formatting in test docs 2013-07-09 17:08:37 -04:00
Mike Cooper bf55ffcbe6 [Bug 888938] Add some docs for Selenium tests. 2013-07-01 19:48:07 -07:00
Will Kahn-Greene 34adfcbd0c Update docs and remove note about Babel 
Since Babel in vendor/ is the correct version now, we no longer need
to tell people to install it in their virtualenvs.
 2013-06-10 21:19:33 -04:00
Berker Peksag c84bdf6332 Fix a Sphinx warning. 2013-06-06 21:23:59 -04:00
Will Kahn-Greene c8d0f4e55c Update test docs 2013-06-06 14:30:23 -04:00
Ricky Rosario 54ddbae078 [bug 872538] Move apps from apps/ to kitsune/ 2013-06-06 11:22:30 -04:00
Will Kahn-Greene 4ec53da6ff Update settings_local.py bits in docs 2013-06-03 21:12:20 -04:00
Will Kahn-Greene 7587854aa2 Peg MariaDB to a specific version in docs 2013-05-29 10:26:48 -04:00
Mike Cooper 017d8d11c7 [Bug 845773] Kill Highcharts. 2013-05-22 11:19:19 -07:00
Ricky Rosario be72773f59 Add note about lib/languages.json to localization docs. 2013-04-17 12:42:15 -04:00
Börni 757a7767cf updated the 'Take the Bug' doc section. Make clear that you need special perms to see the 'take' link. 2013-04-11 16:24:23 -04:00
Ricky Rosario 635059a600 Make that a proper sentence. 2013-04-05 11:46:41 -04:00
Ricky Rosario 89ed0631ae Update dev deploy docs. 2013-04-05 11:42:26 -04:00
Jen Fong-Adwent 6360b681a7 ignore node_modules and changed docs to install less globally 2013-04-05 10:53:57 -04:00
Will Kahn-Greene 6e777fa83a Literally include the LICENSE 2013-04-03 12:06:55 -04:00
Will Kahn-Greene 798afe7f88 Fix docs regarding boosts 2013-04-03 11:05:47 -04:00
Will Kahn-Greene da1e8cd1ed Cosmetic change to kick deployment 2013-04-03 10:53:41 -04:00
Will Kahn-Greene dfd6de7aa1 Add note about git@ urls 2013-03-28 14:29:51 -04:00
Will Kahn-Greene 9a2c323930 [bug 831005] Update to elasticutils master tip 
* add document_id to index
* update to elasticutils master tip -- this picks up pyelasticsearch
  and ditches pyes
* nix get_indexing_es (it was dumb)
* remove bunch of now-unused settings (also dumb)
* tweak test scaffolding -- this should make tests run faster
  for kitsune in a VM and on slower machines
* clean up docs

Note: This doesn't remove pyes. For the purposes of making this easier
to review, that'll get done in a future commit.

Note: This adds a new field to the mapping, but it's only used in indexing
and it's obviously a string. Thus it's ok for ES to infer what it is
and we don't have to do the "change the mapping" two-step dance.
 2013-03-28 14:29:51 -04:00
Will Kahn-Greene 4a5fc2f079 Move TEST_CHARSET/TEST_COLLATION text up 2013-03-26 16:39:41 -04:00
Ricky Rosario fe0ac36bb4 Fixes and changes to Hacking HOWTO. 
* Make LESS required
* Move LESS and memcached instructions to the Requirements section.
* Tweaked and moved the NOTE about empty CSS to the part where
  the issue may be encountered.
 2013-03-26 16:29:39 -04:00
Ricky Rosario 09c6bff2eb Tweak docs: make test db setup consistent with dev db. 2013-03-26 15:42:40 -04:00
Mike Cooper f50155d302 Move about:support add-on to AMO. 
* URL for the add-on is now a setting, to change it easily.
* AMO will provide automatic updates to the add-on. We could have done
  this in SUMO, but it is not trivial.
* The url used here will automatically point to the latest version.
* Remove the old add-on from the media directory.t
* Add docs about the add-on.
* The version of the add-on in AMO will work on -dev and -stage.
 2013-03-18 12:59:40 -07:00
Rehan Dalal 40e7909bb5 [bug 810529] Implement new get involved page 2013-03-14 10:35:18 -04:00
Ricky Rosario 56f4425258 Update docs to reflect our current ES version. 2013-03-13 10:20:58 -04:00
Will Kahn-Greene d407f0b8f2 Add docs for QA test suite 
* documents location of QA test quite
* documents qatestbot and kicking off tests
 2013-03-05 08:42:41 -05:00
Will Kahn-Greene 196d17afa5 Add email template documentation 2013-03-01 13:41:19 -05:00
Will Kahn-Greene 77240fffc7 Tweak formatting of dev docs 2013-02-14 21:42:16 -05:00
Will Kahn-Greene e07fd39f38 Minor cleanup to the mapping change docs 
This tweaks some language, adds some lists, and fixes some incorrect
things.
 2013-02-14 21:31:07 -05:00
Will Kahn-Greene 8bf28fd45c Add SOP section with procedure for fixing strings 2013-02-14 11:58:16 -05:00
Will Kahn-Greene c4a8a0ad7e Tweak memcached section and add trouble-shooting section 2013-02-11 09:38:30 -05:00
Will Kahn-Greene ef3193ab99 Add link to email chapter in advanced install 2013-02-07 11:50:41 -05:00
Berker Peksag 4e89033974 Add a note about regenerating the `.less.css` files. r=willkg 2013-02-03 21:03:51 -05:00
Will Kahn-Greene 9d7bda844e Add xx locale for testing 
This adds:

1. xx locale which is Pirate
2. scripts/poxx.py which translates a .po file into Pirate
3. scripts/test_locale.sh which extracts strings and runs poxx.py

The xx locale is set up so that it doesn't show up in the language
chooser lists, but you can explicitly specify it in the url:

    http://localhost:8000/xx/home

The locale is only available translated locally--it will show up
as English on -dev, -stage, and -prod. It'll show up as English
if you don't run scripts/test_locale.sh.
 2013-01-28 17:57:04 -05:00
Will Kahn-Greene 0c23b8c1c3 Fix typo; add toc to localization docs 2013-01-25 15:51:15 -05:00
Will Kahn-Greene 473de86c7b Document the Babel requirement 2013-01-25 15:38:43 -05:00
Will Kahn-Greene d4af84d068 Nix settings_local.prod.py 
Nixed settings_local.prod.py from the codebase. It never gets updated,
it was old and stale and stinky like the floor of your local dive bar,
and we have better docs already elsewhere.
 2013-01-22 09:41:04 -05:00
Berker Peksag 2b9941c574 Copyright updates for 2013. 2013-01-08 09:57:17 -05:00
Ricky Rosario 731e1ddb52 Add sample data instructions. 2012-12-21 10:13:12 -05:00
Will Kahn-Greene b6f52e2e60 Add TOC to hacking_howto 2012-12-11 18:35:00 -08:00
Will Kahn-Greene 93eabd94fe Move install bits to hacking_howto; cleanup 
* clean up the settings_local.py example
* move the redis install and configuration bits to a separate chapter
* add links to the advanced installation section
* moved some bits that were in installation chapter to the hacking_howto
* fixed the note about Elastic Search 0.19.9 so it's correct.
 2012-12-11 18:25:48 -08:00
Ricky Rosario 0e922b0089 [bug 797783] Add Locale model. 
Includes migration to create and populate table.
 2012-11-26 17:57:22 -05:00
Kadir Topal 175e473594 Add info about email on command line 2012-11-26 08:47:02 -05:00
Berker Peksag 48cdd716de Remove the duplicate paragraph. 2012-11-15 09:26:57 -05:00
Cesar Carruitero 54226de7c9 correct less install instructions 2012-10-30 01:02:36 -04:00
Cesar Carruitero 3e39ab1321 Tweak docs: password db 2012-10-24 09:11:24 -04:00
Will Kahn-Greene ba9dd9fa1f Nix setting from the docs 
We don't have it set up like this on our machines and if you don't have
redis running, then this causes a bunch of odd problems.

Better to nix it from the docs.
 2012-10-12 17:56:35 -04:00
Will Kahn-Greene a8dd1b2ef1 Add note about ES 0.19.9 not working 2012-09-19 11:32:13 -04:00
Rehan Dalal dee9b09e4d Add sleep duration setting fo ES tests 2012-08-21 14:12:09 -04:00
Ricky Rosario f80f961aab Added karma section with a TODO in it. 2012-08-03 10:15:25 -04:00
Mike Cooper 257969a1b4 Fix SQL syntax error. 2012-08-02 17:17:45 -07:00
Will Kahn-Greene 5a6e395cca Tweak hacking howto 
Mike made some changes to our Input docs and I'm reflecting some of
that here.
 2012-08-02 20:09:02 -04:00
Will Kahn-Greene 64286af6e7 Update hacking howto 
I nixed the Redis section. It shouldn't be in the hacking howto.
I also tweaked the text at the top to be clearer that if you're
running a production instance, you should read all the way through.
 2012-08-02 18:47:58 -04:00
Will Kahn-Greene 15b6ea82f6 [bug 778768] Implement reindex by doctype 
This allows us to reindex a specific doctype from the cli and the
admin. This helps when we only need to reindex the kb--now we don't
have to reindex everything with it.
 2012-08-01 18:50:37 -04:00
Will Kahn-Greene 9ba05180fd Add examples for localization docs 2012-07-30 10:15:54 -04:00
Will Kahn-Greene 93d950d7c0 Update search docs 
This updates the search docs removing the text about bucketed and
unified search views and all that.
 2012-07-26 13:52:01 -04:00
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