Closed Bug 957802 Opened 10 years ago Closed 4 years ago

Streamline new contributor setup

Categories

(developer.mozilla.org Graveyard :: Setup / Install, defect)

defect
Not set
normal

Tracking

(Not tracked)

RESOLVED WONTFIX

People

(Reporter: groovecoder, Unassigned)

References

Details

Per Bhudbenswar sprint feedback, we need to streamline the Kuma contributor path. Some ideas discussed:

* Fix & improve non-vagrant installation & instructions [1]

* Stub out secondary services - kumascript, elastic search, celery

* Provide cloud-hosted instances for contributors to use

We should discuss here and file blocker bugs.

[1] http://kuma.readthedocs.org/en/latest/installation.html
ubernostrum: Did you ever get Kuma running without vagrant? If so, can you point out the most troublesome spots here or in a blocker bug?
Flags: needinfo?(jbennett)
The most common cause of Vagrant issues, from what I have seen, is having the wrong version installed. As simple as this seems, it can cause hours of confusion.

Should we name the required version of Vagrant in the documentation, and keep it up to date?
One more important thing is to update the documentation of Kuma installation. Its kind of incomplete and not very helpful. The document is not self sufficient for a new contributor to get started.
@groovecoder: I have installed Kuma thrice in Virtualenv. The trouble is in getting the system libraries installed, like libxml, libxslt, libtidy etc. This becomes more troublesome on Windows. Getting Python packages is the least of the hassles.

A stream of commands can be very helpful. Maybe we can even write shell scripts and ask users to simply run them to install the dependencies. That shell script would detect platform and run specific installation commands. Something like what Gitlab[1] does.

Usually people who come to these code sprints are Windows users, and the only way left for them is to install Vagrant. But these people usually have 1-2GB of RAM on their laptops which is almost never enough to run Vagrant. So, either we declare that Vagrant is officially the only way to install Kuma on Windows, or prep the Virtualenv documentation to support Windows as well.

[1] - https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/installation.md
Flags: needinfo?(jbennett)
(In reply to Kaustav Das Modak [:kaustavdm] from comment #4)
> @groovecoder: I have installed Kuma thrice in Virtualenv. The trouble is in
> getting the system libraries installed, like libxml, libxslt, libtidy etc.
> This becomes more troublesome on Windows. Getting Python packages is the
> least of the hassles.
> 
> A stream of commands can be very helpful. Maybe we can even write shell
> scripts and ask users to simply run them to install the dependencies. That
> shell script would detect platform and run specific installation commands.
> Something like what Gitlab[1] does.
> 
> Usually people who come to these code sprints are Windows users, and the
> only way left for them is to install Vagrant. But these people usually have
> 1-2GB of RAM on their laptops which is almost never enough to run Vagrant.
> So, either we declare that Vagrant is officially the only way to install
> Kuma on Windows, or prep the Virtualenv documentation to support Windows as
> well.
> 
> [1] -
> https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/installation.md

Besides lacking of RAMs as mentioned by Kaustav, the age of the machine also does matters. I still remember during last summit I tried to setup Kuma in the my 4 years old linux machine and its doesn't work.  Documentation should also include alerts on firewalls and ports. From my experience, most universities block a great deal of ports. As newcomer, they should take note on this issue too.
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/7f0f0ef27a6af41fe4c03eb1a819c0847e1f5716
bug 957802 - add irc logs link; update other links

https://github.com/mozilla/kuma/commit/68679fcf2c5e07dec9c6a31fb2d3dfc0d70e3cfe
Merge pull request #2725 from groovecoder/dev-irc-logs-957802

bug 957802 - add irc logs link; update other links
Commit pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/8e426d283b6a2d7b832c10d96e8e2bf75ff0bf04
bug 957802 - Readme: Use SVG badges.

Those badges look better on 2x (and more) displays. They're also a smaller download.
Depends on: 1075135
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/92e7ec64d2db8d11e2adfaccd7cf5aada94db2d1
Bug 957802 - make the homepage url more explicit

https://github.com/mozilla/kuma/commit/6e95cfa642e0e4c4f204582a1d253f1a9d84bc60
Merge pull request #2927 from maurodoglio/bug-957802-explicit-homepage-url

Bug 957802 - make the homepage url more explicit
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/e0f80105e1d7c46e9415b3dfebcaa7be9502acbe
bug 957802 - docs for GitHub auth

https://github.com/mozilla/kuma/commit/4f4582968eb31d7bfdce602b4526b6a6d13b9122
Merge pull request #2975 from groovecoder/github-login-instructions-957802

bug 957802 - docs for GitHub auth
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/ef981f2e992efe718a3f1a0cec0a2488e4d798a8
Bug 957802: Removed link to GitHub issues.

Having a link to GitHub issues on "What to work on" leads possible
contributors to a page that just says "Bummer, we couldn't find
anything.".

https://github.com/mozilla/kuma/commit/06f09e8c365937ff886dea24bd9ac8c63beae1cb
Merge pull request #2977 from adusca/master

Bug 957802: Removed link to GitHub issues.
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/2d2ce67278600a57e32c0221803d2b1ba3c2bfc3
bug 957802 - update screenshot email address

https://github.com/mozilla/kuma/commit/d261757eb6539410f86a2a3b37c916a20ee6e1de
Merge pull request #2990 from groovecoder/update-badge-email-957802

bug 957802 - update screenshot email address
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/fa61029dee414b928cd8b9f3b2c5c579d2fc6019
bug 957802 - import actioncounters.utils from kuma

https://github.com/mozilla/kuma/commit/190fb4a62ffbc1701c5f3b693547e0aa4b7314b4
Merge pull request #3013 from groovecoder/fix-actioncounter-migration-957802

bug 957802 - import actioncounters.utils from kuma
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/5492484a4238af8bbc2b104e003354a9f87aa75b
bug 957802 - update whatsdeployed link

https://github.com/mozilla/kuma/commit/44fcaaeacaa1687d851bc241eb05eb635f88ae77
Merge pull request #3025 from groovecoder/updated-whatsdeployed-link-957802

bug 957802 - update whatsdeployed link
PR 3054 [1], which is also related to this bug, was recently merged. We forgot to include the "Bug ### - " prefix in the commit message, so the automated message didn't show up here.

[1] https://github.com/mozilla/kuma/pull/3054#issuecomment-72920061
Assignee: nobody → jezdez
Status: NEW → ASSIGNED
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/a4360538c7cfd3d463a2e3ee9afb7771aac1087f
Bug 957802 - Use Sphinx MDN theme for kuma docs.

https://github.com/mozilla/kuma/commit/7345491c61489afdb71226a43d1d94ca1791c05b
Bug 957802 - add indentation to TOC items in sphinx

Changed the element the padding is added to in TOCs so that indentation appears whether or not the parent element is a <ol>  (as we use on MDN) or <ul> (as readthedocs uses).

https://github.com/mozilla/kuma/commit/fbd1dc43a711335199a8f0c9fea2e5cbf75eb1f2
Merge pull request #3068 from mozilla/bug957802

Bug 957802 - Use Sphinx MDN theme for kuma docs.
Assignee: jezdez → nobody
Status: ASSIGNED → NEW
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/86f5e61df8aca291e7eef2a2b04e7c97e8ccde2c
bug 957802 - clean & update CONTRIBUTING.md

https://github.com/mozilla/kuma/commit/44bdc54a167498517bdbe3cf79491384c8fb0c63
Merge pull request #3106 from groovecoder/how-to-submit-code-957802

bug 957802 - clean & update CONTRIBUTING.md
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/f3b7f794e491a3e6ce394d40239b823feb899122
bug 957802 - doc kumascript auto-loaded modules

https://github.com/mozilla/kuma/commit/24c16afb3b72f2123b89ef06cee4d7aa2c316edb
Merge pull request #3112 from groovecoder/doc-kumascript-autoload-modules

bug 957802 - doc kumascript auto-loaded modules
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/b598c33ec279433f631e428dffbaad2a3b68e5ed
bug 957802 - Fixing for incorrect link to troubleshooting page.

On installation-vagrant page there is an invalid link to troubleshooting page,
this patch fixes that.

https://github.com/mozilla/kuma/commit/40b540d392c5cdd537fe5660edee75be96f3d48d
bug 957802 - change troubleshooting links

https://github.com/mozilla/kuma/commit/4637e304a4c615a7191094027bfc0b1244feb017
Merge pull request #3155 from groovecoder/install-docs-cleanups-957802

bug 957802 - install docs cleanups
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/cbebb09d5dfabfa716c1e2d5283e9558fedb410d
bug 957802 - update ui-tests docs

https://github.com/mozilla/kuma/commit/c0e5d10006effdea3ba087280a6f97f54264de70
Merge pull request #3167 from groovecoder/update-ui-tests-957802

bug 957802 - update ui-tests docs
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/a8dede798ddd4b32acf953bbf40f96891a6326fa
bug 957802 - pin puppetlabs-apt module version

https://github.com/mozilla/kuma/commit/c456221d13ba6875fb776f1030fdebeeacca0cef
Merge pull request #3200 from groovecoder/pin-puppet-apt-module-957802

bug 957802 - pin puppetlabs-apt module version
Depends on: 1158142
Depends on: 1158149
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/a0b6a2873114f865f42250a4fbabf22347268a5e
bug 957802 - Remove bad link

https://github.com/mozilla/kuma/commit/30876ecc79ca2496417fe1214b73ff035ae1d81c
Merge pull request #3286 from groovecoder/remove-bootcamp-link-957802

bug 957802 - Remove bootcamp link
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/6dc9f547657b3977ee03d34d444afab6f2303180
Bug 957802 - Switch to Codecov from coveralls.

https://github.com/mozilla/kuma/commit/687fb253cb150d71c94d5f872646b540a396028e
Merge pull request #3307 from mozilla/codecov

Bug 957802 - Switch to Codecov from coveralls.
Component: General → Setup / Install
OS: Mac OS X → Unspecified
Hardware: x86 → Unspecified
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/eb98d248a3baee43dfc1c28983e515b3bc2cbe64
bug 957802 - Ignore .pyc changes in submodules

For select submodules that don't have .pyc in their .gitignore, add
ignore = untracked, so they don't show up in `git status`.

https://github.com/mozilla/kuma/commit/6775796c8efe12d8af9234621aad3e7001f30a7c
bug 957802 - Normalize attribute order

In kuma/wiki/content.py, ContentSectionTool now delays initializing the
serializer until .serialize() is called, which can take keyword
arguments to override the default serializer options. This is used in
the normalize_html test function to order attributes, removing an
occasional test issue.

https://github.com/mozilla/kuma/commit/0567c7cb3ed9f335c7041d93b82cec61cd555f21
bug 957802 - Really mock strings_are_translated

The test test_dont_send_untranslated_language_email was performing a
real check of string translations. Mock the checking function at the
right position, and use it to fail then succeed at sending a Klingon
message.

https://github.com/mozilla/kuma/commit/8d4d10dcee8b1c88c6988bcc2076eb852bf24475
Merge pull request #3330 from mozilla/fix_tests_957802

bug 957802 - Fix issues running tests in new vagrant install
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/3d6535065c651aefbf8f84d744ee05d712dd1e7f
bug 957802 - Improve mysql init script

/etc/init.d/mysql greps for the mysql process to determine if mysql is
running.  When running, the process count includes the mysqld process
and the grep for that process.  However, 5% - 10% of the time, the grep
is not in the process list, causing false negatives when detecting the
mysqld process is running.  This new init script ignores the grep
process, making the run detection more reliable.

https://github.com/mozilla/kuma/commit/55152a1d13fb599d0cd4eb70a28ff43b41e9dca2
Merge pull request #3339 from mozilla/better_mysql_init_957802

bug 957802 - Improve mysql init script
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/19d9c9995b8b82abbbc0710faf58a28c65eeab54
Bug 957802 - Reverted modification of vendored MySQL role and moved it into kuma role.

https://github.com/mozilla/kuma/commit/0b056d8938be92ee3159934feefbd4d1d4dc78ad
Merge pull request #3340 from mozilla/bug957802-2

Bug 957802 - Reverted modification of vendored MySQL role and moved it into kuma role.
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/b1ff0dcb2cf8d6058737568e1f86c6fd9e1fd853
Bug 957802: Ignore sanitized database dump

I always worry when copying the sanitized database dump to the project
root before importing it. Let's be sure it can never be committed.

https://github.com/mozilla/kuma/commit/0045030fee1c9de68830d71b61ee67dbaecd63dd
Merge pull request #3345 from openjck/ignore-db-dump

Bug 957802: Ignore sanitized database dump
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/b751a5f9faddfbf6b38e5bc93f91c716898b802f
bug 957802 - update test repo url and add doc link

https://github.com/mozilla/kuma/commit/a1037dd43760dd271125c07dfc70a46fa5cb750b
Merge pull request #3356 from mozilla/remove-mdn-tests-repo-957802

bug 957802 - update test repo url and add doc link
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/848903d2197356b6919d8205871f2aff088b9ccb
Bug 957802 - Correctly detect environment variables in Vagrantfile.

https://github.com/mozilla/kuma/commit/31a5555f48384af309c4bdf243920c1bd1477045
Bug 957802 - Use Ubuntu 64 setting for Virtualbox VM.

https://github.com/mozilla/kuma/commit/5946c12297fd683d84c9a56838e3f84dd7ad1d38
Merge pull request #3364 from mozilla/bug957802-3

Fix reading of environment variables, default to 64-bit Ubuntu for new VMs.  Impacts local VM development only.
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/14fc19360c9921f8e83381b599752390a447601e
Bug 957802 - Make sure the language mapping isn't exectured until Django is ready.

https://github.com/mozilla/kuma/commit/3bb9c268cefdce02ceb774d1af7456cc25c2c005
Merge pull request #3393 from mozilla/bug957802-4

Bug 957802 - Make sure the language mapping isn't exectured until Django is ready.
Some few extra feed back based on my recent experience with installing Kuma locally:

1. By default the wiki is in readonly mode.
It's necessary to set up the kumaediting flag manually to change that. As it wasn't said anywhere I spent quite some time figuring what was wrong. That would be nice if it could be set up by default. Actually, It would be awesome if all flags and switchs could be set up and activated by default.

2. KumaScript is "naked"
By default, it misses some basic templates to work smoothly. Those are: Template:MDN:Common, Template:DekiScript:Date, Template:DekiScript:Page, Template:DekiScript:String, Template:DekiScript:Uri, Template:DekiScript:Web, Template:DekiScript:Wiki. It worth noticing that when you create a new page or updating one, those templates are expected and generate 404 server answers. They should be set up by default.

Same thing for all things related to live samples, it miss Template:EmbedLiveSample, Template:CustomSampleCSS, Template:LiveSampleURL (with proper domain name set up)

3. At a very basic level, it would be nice if the DB could be populate with some basic content.
I dont mean a real dump of MDN—even if that could be sweet—just some basic configuration and simple content to be tested. For example: as a sample article page, a page with a sample of all CSS class in use (a style guide), a page dedicated to each JS feature, and so on. That would make automated testing and patch review way easier.
Commit pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/c6776e3aae26ac320dc8fa6ad4473785ce317cac
fix bug 957802 - but not rly tho

emphasize the contribution guide as the jumping off point
Status: NEW → RESOLVED
Closed: 9 years ago
Resolution: --- → FIXED
Status: RESOLVED → REOPENED
Resolution: FIXED → ---
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/77b4ea58b02a5b51f146423e335dfc59d80e4890
Bug 957802: Allow all hosts in settings_local.py

The ALLOWED_HOSTS setting needs to be set to disable debug mode and
emulate production locally.

https://github.com/mozilla/kuma/commit/8768c985a178f3d80636713ff93ec950632c668a
Merge pull request #3494 from openjck/bug-957802-allowed-hosts

Bug 957802: Allow all hosts in settings_local.py
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/975a76f99c29d14945a735506e2ecf32ef7a54a0
bug 957802 - Add in vagrant / on host targets

https://github.com/mozilla/kuma/commit/807d5d0722edc9db8cc9dd13a8c4a42e7ff35594
bug 957802 - Add make coverage

On host, "make coverage" will run coverage and open HTML report
On VM, "make coverage" will run coverage and write to terminal
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/f14117a2b16d799ac31be2c28391d7b69e664902
bug 957802 - serve fonts to local.allizom for devs

https://github.com/mozilla/kuma/commit/e6b29bb89d3b0f5d5e2f22ed8ab44cd9be74ab75
bug 957802 - disable django debug by default

https://github.com/mozilla/kuma/commit/41c4a506bdc8902fd4622a7aa1fc593dbf1cb9c2
Merge pull request #3501 from mozilla/dev-vm-fonts-957802

bug 957802 - serve fonts to local.allizom for devs
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/d45079740c27bd817339329168e05a6e238c9b55
Bug 957802: Make DB ignore more generic

The .gitignore file is updated to also match files named
devmo_sanitized.sql

https://github.com/mozilla/kuma/commit/601771b91d0f69c8c192d10ba68c4f1526cec1c1
Merge pull request #3509 from openjck/bug-957802-ignore-db-dump-2

Bug 957802: Make DB ignore more generic
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/2a1988312f2e44ed027560e80886833d2086e98a
bug 957802 - re-arrange kuma docs and toc

https://github.com/mozilla/kuma/commit/f402b28d406b79a73b2a6bb1cf923ef9d66d6c35
Merge pull request #3507 from mozilla/update-install-docs-957802

bug 957802 - re-arrange kuma docs and toc
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/4b3fe1433d45d5178cf0345f52000125136cfbca
Bug 957802 - Stop writing pyc files in the VM.

https://github.com/mozilla/kuma/commit/320a235be1726fd12e5481b5c20de6b544b9573e
Merge pull request #3709 from mozilla/no-pyc

Bug 957802 - Stop writing pyc files in the VM.
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/ff018417216315b455c74925b2ab7411335e3a43
bug 957802 - import_kumascript_modules command

https://github.com/mozilla/kuma/commit/1861ca582e44cacdb5b1a52285b37ff3c74536bf
Merge pull request #3689 from mozilla/easy-ks-modules-957802

bug 957802 - import_kumascript_modules command
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/b290516f6615c52a7a9b6db8541e74f281c8aff1
Bug 957802 - Update local SSL cert to use SHA256.

This should prevent Chrome from showing a broken cert all the time starting 1/1/16.

https://github.com/mozilla/kuma/commit/bf72274fb7383fda949c329301be8857d8698cda
Merge pull request #3721 from mozilla/ssl-cert

Bug 957802 - Update local SSL cert to use SHA256.
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/c102c619e367e22ae46f3fbc24dcc1c4faf56a5c
Bug 957802 - Fix documentation build until RTD supports pip8 requirements files.

See https://github.com/rtfd/readthedocs.org/issues/1958 for a follow-up.

https://github.com/mozilla/kuma/commit/f88b18e5dd03edd6a0f2ecce87d7183a09bd870e
Merge pull request #3775 from mozilla/broken-docs

Bug 957802 - Fix documentation build until RTD supports pip8 requirements files.
Commit pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/6c0071f5eae1fec54b4f344b47ef743970b80ca9
bug 957802 - Safer clean, generate coverage HTML

"make clean" deletes the whole build folder, and now creates empty
build/assets and build/locale folders so the server will run correctly.

"make coveragetesthtml" builds the HTML coverage files in the htmlcov
folder, which makes it easier to view missed lines and partial branches.
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/c801018a7db147d32300a97aae81a5b13b3cacbc
Bug 957802 - Update docs and provisioning to compile mo files

https://github.com/mozilla/kuma/commit/b0e6b9a6975cc46e5b775607e8217eb469b0926e
Merge pull request #3819 from robhudson/957802-mo

Bug 957802 - Update docs and provisioning to compile mo files
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/5e43fe88178d41d0ce1eb6ef0fb9620152a9a60a
bug 957802 - Remove cached folder for NPM

vagrant-cachier was being used to share the VM's /root/.npm folder
between virtual machines. This was causing issues around permissions,
which appear in the ansible output as messages like:

Error: Attempt to unlock /usr/lib/node_modules/bower-installer, which hasn't been locked

This appears to be an issue with reading or writing /root/.npm/_locks,
and interpreting permissions problems as the need to lock or unlock the
file.

In any case, disabling the cache allows the ansible build to globally
install npm packages.

https://github.com/mozilla/kuma/commit/bae3148356831a95d2a9c930f40d85635238b1fc
bug 957802 - Upgrade fibers to 1.0.10

fibers 1.0.1 errors with compliation issues.

https://github.com/mozilla/kuma/commit/49137991bfd1e94c5d94afea5db592857a5f1c87
Merge pull request #3850 from mozilla/vagrant-npm-957802

bug 957802 - Vagrant build fixes
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/67387dabe2308c87f2f6a7728fc3a849b66a0318
bug 957802 - Documentation updates

https://github.com/mozilla/kuma/commit/147ded32e597f5a1b1db439a19d43c4e5f5eee1c
bug 957802 - Add ability to disable cachier plugin

The environment variable VAGRANT_CACHIER will be disabled if set to
'false'.

https://github.com/mozilla/kuma/commit/76eefe0a30c435d6ad953aed979782dc862a4fc1
bug 957802 - Run two worker threads for KumaScript

Run two web workers, so that KumaScript can make requests while Kuma
is requesting rendering.

https://github.com/mozilla/kuma/commit/cfad3f405aff08b0116e4d76c8b37c670133ef61
Merge pull request #3855 from mozilla/doc_update_957802

bug 957802 - Vagrant install fixes

r=groovecoder
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/11b10d9e69591ae2ea8f8231e7bcdffdf1126928
bug 957802 - Adjust Linux errors section

Change title, column wrap, and clean up sentence structure

https://github.com/mozilla/kuma/commit/5d197d351e8fac732027ae0ee61cd39c5fcf1372
bug 957802 - Move to Ubuntu section in install

https://github.com/mozilla/kuma/commit/ef94921c93bafaed5763d27a78927686bc275fa4
Merge pull request #3858 from mozilla/linux-statd-doc-update-957802

bug 957802 - Add install notes about NFS / statsd for Ubuntu
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/6eb58ccb9bcf9c544a62668932526ac0447f6ac8
bug 957802 - Add dennis, locale make targets

dennis is used to check locale files for common errors. Added some
make targets for locale work:

make localetest - Run dennis on locales
make localeextract - Extract translatable strings
make localecompile - Compile translations for local use
make localerefresh - Run all the steps to update locales, except for commit

Updated the localization documentation for these new targets.

https://github.com/mozilla/kuma/commit/16c2b22750a94428c247eba32f580a0dbd73e5ad
bug 957802 - Update instructions for adding locale

* Use make targets when useful
* Correct the paths to the new settings files
* Add dennis version of debug translations

https://github.com/mozilla/kuma/commit/6223836dd3002dafd0bff3be58e75c4f458f4188
bug 957802 - Stop deploy if locales have errors

Run dennis to lint the locale files before deployment. This will detect
locale issues on stage before they go to production. The translation can
usually be fixed in Pontoon, which will update the master branch.

https://github.com/mozilla/kuma/commit/9bf407d217e44a0d378fb9f19a0a0bfdd3d6bd06
bug 957802 - Check local .po headers

Update compile-mo.sh to call msgfmt --check-header. Update headers so that
they pass checks.

https://github.com/mozilla/kuma/commit/b93d4758526498e45d0317b639b6e2073c5d9c1f
Merge pull request #3860 from mozilla/update_locale_tools_957802

bug 957802 - Add dennis, make targets for locale, local linting

r=willkg
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/72400692a83bf748f5f298f02ee2111d61220c02
bug 957802 - Enable django-debug-toolbar

In developer VMs, setting environment DEBUG_TOOLBAR=1 will enable the
Django Debug Toolbar, useful for tracking database requests, cache
usage, etc.

https://github.com/mozilla/kuma/commit/143364a4070d18ffb05b2fce6d2de844167566c4
Merge pull request #3862 from mozilla/debug_toolbar_957802

bug 957802 - Enable django-debug-toolbar

r=robhudson
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/67aa2695c3d965847a933c39bf9e87d788280682
bug 957802 - Remove references to dropped tables

These tables are confirmed removed from the production database.

https://github.com/mozilla/kuma/commit/4428083fc0e33f4bb9c0e9a07e40d5658dbfb35e
bug 957802 - Unforce DB in check_anonymize.sql

Allow scripts/check_anonymize.sql to be used on any database,
not just developer_mozilla_org

https://github.com/mozilla/kuma/commit/bd9e2330ebb81d4bcb8c64b6445c8cd7f91e1d22
Merge pull request #3906 from mozilla/db_anon_updates_957802

bug 957802, others - Update DB anonymize scripts
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/33a92c4d6322592b154103b031e1d7c06d7dca1b
bug 957802 - Update CKEditor docs

Update the CKEditor documentation to reflect the removal of the
submodule version back in PR #2995 / bug 975868, and edits to the
build.sh script in PR #3932.

https://github.com/mozilla/kuma/commit/350e7d870df405b5252bbfc05e797269f896e2b2
bug 957802 - Update paths to readthedocs.io

On April 27, 2016, Read The Docs moved hosted projects from
readthedocs.org to readthedocs.io:

https://blog.readthedocs.com/securing-subdomains/

This updates the URLs and ensures they use the https: protocol.

https://github.com/mozilla/kuma/commit/4e5af94abf6a4943a9a0c03fdbec43cb6c4628b0
bug 957802 - Fix markup for Pontoon link

https://github.com/mozilla/kuma/commit/7bfbd30c09d8316a9769383b698a451b58747911
Merge pull request #3930 from mozilla/doc_updates_957802

bug 957802, 1286541: Documentation updates
Commit pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/16a2b4441e29656973ab7e9c4bc1f16523abed70
bug 957802: Fix ansible file-finding issue

Ansible 1.9.2 - 1.9.5 are having trouble finding at file for the "add
the official rabbitmq repository" step:

input file not found at
kuma/provisioning/roles/Mayeu.RabbitMQ/tasks/files/rabbitmq.list
or kuma/provisioning/rabbitmq.list

The file is at

kuma/provisioning/roles/Mayeu.RabbitMQ/files/rabbitmq.list

This is the fix suggested by the upstream bug:

https://github.com/ansible/ansible/issues/13671
Commit pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/63b56dfbad1220bd9001632362d6774bdcbc9bb8
bug 957802: Arrange soapbox to eliminate warning

If soapbox appears after kuma.wiki, then a RemovedInDjango19Warning
will be emitted for some management commands.
Commit pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/03c286cd4cdfd175756147c14799b09b020d0ec1
Merge pull request #3964 from safwanrahman/travis

bug 957802: Update travis.yaml
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/1b51e7e4428a6ed4fecccb2941c5d4d372caa62e
bug 957802: Update nodesource.node role

https://github.com/mozilla/kuma/commit/3479f1ff9bfa0efc5c98536125f5df2494ee67d3
bug 957802: Install apt-key from Ubuntu keyserver

After switching to CloudFront, the key is stored on a server with SNI,
and the system Python can no longer download the key. Placing the key on
keyserver.ubuntu.com allows Ansible to download it on our legacy
systems.

https://github.com/nodesource/ansible-nodejs-role/issues/33

https://github.com/mozilla/kuma/commit/d009bd48c4602e79cccd9bfa7c2c77af08d6b3d1
Merge pull request #3963 from mozilla/ansible_node_patch_957802

bug 957802 - Update node provisioning
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/79aa543f58fdd6d31e926a79b82d80db60d3ec26
bug 957802: Update flake8, add more spaces

flake8 1.2.3 -> 1.3.0: Bug fixes, bump requirements
configparser 3.5.0: New flake8 requirement
enum34 1.1.2 -> 1.1.6: Packaging updates
pycodestyle 2.0.0 -> 2.1.0: Require two spaces following class, func
pyflakes 1.2.3 -> 1.3.0: py3.5 updates, dup dict key check

The update to pycodestyle requires additional blank lines in several
files.

https://github.com/mozilla/kuma/commit/4ebd277f7b5b354cc013a2a13b6ad0e9954b7f32
Merge pull request #4039 from jwhitlock/flake8_3.1.1_957802

bug 957802: Update flake8, add more spaces
Commit pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/acc6cb1c69e7751b91d3712690ddcf21dafd610f
bug 957802: Copy-edit developer documentation

Fix typos, verb-object mismatches, unneeded double-spacing, and other issues in the development documentation.
Commit pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/37a5a1431ef5e1abab8283f18330b8462e6ceba7
bug 957802 - Improve format of new theme documentation

Convert steps to full sentences.
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/f8273d758e02c07911323bcc6f542f3542e43ca0
bug 957802: Doc - titles and lists standardized

https://github.com/mozilla/kuma/commit/1c1642d4c351529a4786288c1cf98ab4d4020b0f
Merge pull request #4068 from jwhitlock/doc_title_list_fixes_957802

bug 957802: Doc - titles and lists standardized
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/c275052cac096514aed255cc59005e74f4cfa3c5
bug 957802: Show locale diff only on string change

In TravisCI, show the locale diff only if the localizable string
changes. This makes it clearer when a string update is needed.

https://github.com/mozilla/kuma/commit/9731f381f885a3a9270051740b4cfbb8f23240a7
Merge pull request #4124 from jwhitlock/tox_locale_diff_957802

bug 957802: Show locale diff only on string change
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/b80d9065c8239fe9b9adbdf1c217f4a82f60e5f9
bug 957802: Update contribute.json

* Move "home" from old Platform dev page to MDN Durable Team homepage
* Update IRC handle list
* Fix mentored bug link
* Drop "goodfirstbug" link, not used in current process
* Swap keyword "vagrant" for "docker"

https://github.com/mozilla/kuma/commit/f19cc73ec317756e85b2db0847ad4aabea7a438c
Merge pull request #4131 from jwhitlock/contribute_957802

bug 957802: Update contribute.json
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/e84cd41a46681d563e878c917b0828516ed0c56b
bug 957802: Fix some documentation nitpicks

* Bump documentation requirements
  * Drop alabaster (ships w/ Sphinx)
  * Drop sphinx-rtd-theme (not used)
* Fix Sphinx warnings about title underlines
* Change page title from "Kuma latest documention" to "Kuma
  Documentation"
* Shorten long section names
* Rearrange sections so testing sections are together

https://github.com/mozilla/kuma/commit/ea5c91ee64a1f55db4548e40a776979b682ed018
bug 957802: Make flake8 happy
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/f2b0e06b355fe25a3ea3818e637096e3600dc2b1
bug 957802: flake8 for functional, redirect tests

https://github.com/mozilla/kuma/commit/abae63478da81842999aa42dc270b873ee17ee10
bug 957802: Add flake8 testing for docs and tests

https://github.com/mozilla/kuma/commit/474c282aa3dc3f8f7b34b728fc155da6865aacf7
Merge pull request #4267 from jwhitlock/lint-tests-957802

bug 957802: Enforce code style in functional tests
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/23ee8156eb4cd8b930a3fb63e91f3e3f9ae36798
bug 957802: Add coverage of tests

There's a lot of dead code in the tests, which is invisible because the
tests are hidden from code coverage.

https://github.com/mozilla/kuma/commit/512decf2832a2a497b01dd045fe8cb30b3930ea4
Merge pull request #4385 from jwhitlock/cover-tests-957802

bug 957802: Add coverage of tests
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/3528e0d4f2263ec4ed5008a9e33ed5b600b41a28
bug 957802: Sort results for testing, output

https://github.com/mozilla/kuma/commit/4087054f2341b6a62c7b094c5fd40bb677485356
bug 957802: Remove email test helper

The email test helper had several unused options. Replaced with direct
calls to create the EmailAddress instances.

https://github.com/mozilla/kuma/commit/605e6754c21be4f5c8b8d6a210319a5f5a1bad44
bug 957802: Remove unused test helpers

https://github.com/mozilla/kuma/commit/652532360bfb6184a0a81ff79a2b6c297ba9eee7
bug 957802: Use pytest.raises and exceptions

Use pytest.raises to confirm the expected exception is raised. Let a
test fail if an unexpected exception is raised, rather than catching the
exception and manually failing.

https://github.com/mozilla/kuma/commit/ce6f06db15d953c1924c71a9d0a4860af1ffef40
bug 957802: Simply, remove unexercised branches

https://github.com/mozilla/kuma/commit/44fdc187d4b278ea491c7b6a63c6b0de7858840f
bug 957802: Refactor, fix tests for coverage

Re-write test logic to actually test results, and avoid missing
branches.

https://github.com/mozilla/kuma/commit/d2b42e03e875c8d18b56361518dc9229946cf96a
bug 957802: Remove unused wiki editing test code

This code, part of a poorly written test case, hasn't been called for
over 5 years, and was probably not called when kuma forked from kitsune.

https://github.com/mozilla/kuma/commit/304ff4f4a5498d20939ad822adce7d4d92efdc3b
bug 957802: Convert humans test to not use file

https://github.com/mozilla/kuma/commit/f1ec2d7523ad4545beaa984e32443d4e2dc9de72
Merge pull request #4386 from jwhitlock/cover-tests-2-957802

bug 957802: Remove unused test code and branches
Commit pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/a8529656afaad79b68df9a6a10cf1be9d13c53ca
bug 957802: Update contribute.json

* Remove jpetto from IRC contacts
* Remove ansible from keywords
Commit pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/6b16c92e337be881326eb3d174fa878e6e8f3ef5
bug 957802: Add Code of Conduct, Update Contributing doc (#4674)

* bug 957802: Add Coc, Update Contributing

Add the MDN Code of Conduct, and refresh CONTRIBUTING for current practices:

* Our process is much closer to GitHub flow than the old WebDev workflow
* We have a lot more to say about code style, expecially around tests
* Add more guidance around branch names and commit messages
* Add more about the code review and deployment processes
* Add expectations for a PR to be touched in 2 business days
* Drop requirement for two peers to review database changes
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/44ce7430e12af4f253510004dcfca59cddee8910
bug 957802: Standardize import order

Use the flake8-import-order plugin to enforce edited-style import order.

https://github.com/mozilla/kuma/commit/ee301377adef5ef61367de6c09b25bbb6b67be37
Merge pull request #4727 from jwhitlock/import-order-957802

bug 957802: Enforce import order
Commit pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/0370b875571bbd820ca1310480df42b732e59234
bug 957802: Move string update to pre-deployment

These instructions are a better fit as part of the pre-deployment
instructions then as linked instructions.
Commit pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/b77980e759a1b3e44876407392d9925f7c286639
bug 957802: Test new requirements in locale build

In the TravisCI locale build, use the Python environment and install any
new requirements, rather than using the current Docker image and the old
requirements. This allows verification of updates for Jinja2 and related
libraries.
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/0c5e0815655f33a5aacc1ef06a52f955e05a0224
bug 957802: Add BASE_DIR to fix manage.py notes

Some django-extensions management commands expect settings.BASE_DIR to
be the path to the project root. This adds BASE_DIR as an alternate name
for ROOT.

https://github.com/mozilla/kuma/commit/d1697ecf50138e63329d7ba520a96dd9efe99860
bug 957802: Drop executable for settings

There's no need for kuma/settings/common.py to be executed as a script.

https://github.com/mozilla/kuma/commit/fad7ff110c9e4dd0daf1decaeda7b17e6314099b
Merge pull request #4859 from jwhitlock/manage-notes-957802

bug 957802: Settings changes for ./manage.py notes, drop exec
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/e1ddfba18148431cef33c8e4b42dbb3c861917e7
bug 957802: Fix link to MDN GitHub org

https://github.com/mozilla/kuma/commit/e24111468939ac1d57f0cdb36059379923a22fde
Merge pull request #4919 from jwhitlock/fix-mdn-link-957802

bug 957802: Fix link to MDN GitHub org
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/aff434ca923587774a2eff73122a7adbfbb04c3b
bug 957802: Update P1 hint, PR queues

Sync the P1 hint with the process documents. Drop kuma-lib and mozhacks
from the PR queue list, and add infra and mdn-fiori.

https://github.com/mozilla/kuma/commit/3453d1a436fa00306972a62a06049ef39ec27aaa
Merge pull request #4929 from jwhitlock/p1-hint-957802

bug 957802: Update P1 hint, PR queues
Commit pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/723315c8ae24795b9f7937b676d55b6a5ffe83b6
bug 957802: Set full prefix for STATIC_URL

The relative URL /static/ works for views, but the full URL
http://localhost:8000/static works for emails, and is a closer match to
the settings for staging and production.
Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/6e120462d22615d68483e34c443cb794d57e5381
bug 957802: Fix comment for CONN_MAX_AGE

An integer value is the lifetime of a database connection, in seconds,
not the number of requests before closing:

https://docs.djangoproject.com/en/1.11/ref/settings/#std:setting-CONN_MAX_AGE

https://github.com/mozilla/kuma/commit/73ef76579d73288a512c0b981dfb43abdf69b7d3
Merge pull request #5097 from jwhitlock/conn-max-age-957802

bug 957802: Fix comment for CONN_MAX_AGE
Commit pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/49c985152fb1c23d9cc0474af209d5309fff7775
bug 957802: Document the rendering process (#5216)

Document the steps of the rendering process, with a sample document for
illustration. It's clear that the process evolved over the years, and I
try to emphasize where the process has some unintended effects.
MDN Web Docs' bug reporting has now moved to GitHub. From now on, please file content bugs at https://github.com/mdn/sprints/issues/ and platform bugs at https://github.com/mdn/kuma/issues/.
Status: REOPENED → RESOLVED
Closed: 9 years ago4 years ago
Resolution: --- → WONTFIX
Product: developer.mozilla.org → developer.mozilla.org Graveyard
You need to log in before you can comment on or make changes to this bug.