Skip to content

Commit

Permalink
Merge pull request #4972 from willkg/docs-fixes
Browse files Browse the repository at this point in the history
Update docs
  • Loading branch information
willkg authored Jun 24, 2019
2 parents 0308e32 + 0ea371e commit 3b05998
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 13 deletions.
24 changes: 24 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,30 @@ After that, the commit should explain *why* the changes are being made and any
notes that future readers should know for context or be aware of.


Migrations
==========

Database migrations (django)
----------------------------

We use Django's ORM and thus we do database migrations using Django's
migration system.

Do this::

$ make shell
app@socorro:/app$ cd webapp-django
app@socorro:/app/webapp-django$ ./manage.py makemigration --name "BUGID_desc" APP


Elasticsearch migrations (Elasticsearch)
----------------------------------------

We don't do migrations of Elasticsearch data. The system creates a new index
every week, so any changes to new fields or mappings will be reflected the
next time it creates an index.


Dependencies
============

Expand Down
13 changes: 1 addition & 12 deletions docs/howto.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,6 @@ How to

.. contents::

Run security checks for dependencies
====================================

You can run Django command that checks for security vulnerabilities locally:

::

$ make shell
app@socorro:app/$ socorro-cmd depcheck


Connect to PostgreSQL Database in local dev environment
=======================================================

Expand Down Expand Up @@ -42,7 +31,7 @@ Reprocessing lots of crashes if you are not an admin
----------------------------------------------------

If you need to reprocess a lot of crashes, please `write up a bug
<https://bugzilla.mozilla.org/enter_bug.cgi?format=__standard__&product=Socorro>`_.
<https://bugzilla.mozilla.org/enter_bug.cgi?bug_type=task&comment=DESCRIBE%20WHAT%20YOU%20WANT%20REPROCESSED%20HERE&component=General&form_name=enter_bug&product=Socorro&short_desc=reprocess%20request%3A%20SUMMARY>`_.
In the bug description, include a Super Search url with the crashes you want
reprocessed.

Expand Down
1 change: 0 additions & 1 deletion socorro-cmd
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,6 @@ COMMANDS = [
'db': import_path('socorro.scripts.db.main'),
'es': import_path('socorro.scripts.es.main'),
'pubsub': import_path('socorro.scripts.pubsub.main'),
'depcheck': django_cmd('depcheck'),
}
),
Group(
Expand Down

0 comments on commit 3b05998

Please sign in to comment.