@@ -4,9 +4,6 @@ djangoproject.com source code
4
4
.. image :: https://github.com/django/djangoproject.com/workflows/Tests/badge.svg?branch=main
5
5
:target: https://github.com/django/djangoproject.com/actions
6
6
7
- .. image :: https://coveralls.io/repos/django/djangoproject.com/badge.svg?branch=main
8
- :target: https://coveralls.io/r/django/djangoproject.com?branch=main
9
-
10
7
To run locally, you can either:
11
8
12
9
- Install and run from a virtual environment
@@ -87,7 +84,7 @@ Install and run locally from a virtual environment
87
84
#. For docs (next step requires ``gettext ``)::
88
85
89
86
python -m manage loaddata doc_releases
90
- python -m manage update_docs --update-index
87
+ python -m manage update_docs
91
88
92
89
#. For dashboard:
93
90
@@ -130,16 +127,13 @@ Our test results can be found here:
130
127
131
128
* https://github.com/django/djangoproject.com/actions
132
129
133
- For local development don't hesitate to install
134
- `tox <https://tox.readthedocs.io/ >`_ to run the website's test suite.
135
-
136
130
Then in the root directory (next to the ``manage.py `` file) run::
137
131
138
- tox
132
+ make test
139
133
140
134
Behind the scenes, this will run the usual ``python -m manage test `` management
141
135
command with a preset list of apps that we want to test. We
142
- collect test coverage data as part of that tox run, to show the result
136
+ collect test coverage data as part of that test run, to show the result
143
137
simply run::
144
138
145
139
python -m coverage report
@@ -239,16 +233,8 @@ minified version of it to this directory.
239
233
Documentation search
240
234
--------------------
241
235
242
- When running ``python -m manage update_docs --update-index `` to build all
243
- documents it will also automatically index every document it builds in the
244
- search engine as well. In case you've already built the documents and would like
245
- to reindex the search index, run the command::
246
-
247
- python -m manage update_index
248
-
249
- This is also the right command to run when you work on the search feature
250
- itself. You can pass the ``-d `` option to try to drop the search index
251
- first before indexing all the documents.
236
+ When running ``python -m manage update_docs `` to build all documents it will
237
+ also automatically index every document it builds in the search engine as well.
252
238
253
239
Updating metrics from production
254
240
--------------------------------
@@ -325,28 +311,25 @@ Updating translations from Transifex
325
311
Anytime translations on Transifex have been updated, someone should update
326
312
our translation files as follows:
327
313
328
- 1. Review the translations in Transifex and add to the space-delimited
329
- ``LANGUAGES `` list in ``update-translations.sh ``, any new languages that have
330
- reached 100% translation.
331
-
332
- 2. Pull the updated translation files::
314
+ 1. Pull the updated translation files::
333
315
334
316
./update-translations.sh
335
317
336
- 3 . Use ``git diff `` to see if any translations have actually changed. If not,
318
+ 2 . Use ``git diff `` to see if any translations have actually changed. If not,
337
319
you can just revert the .po file changes and stop here.
338
320
339
- 4 . Compile the messages::
321
+ 3 . Compile the messages::
340
322
341
323
python -m manage compilemessages
342
324
343
- 5 . Run the test suite one more time::
325
+ 4 . Run the test suite one more time::
344
326
345
327
python -m manage test
346
328
347
- 6 . Commit and push the changes to GitHub::
329
+ 5 . Commit and push the changes to GitHub::
348
330
349
- git commit -m "Updated translations" locale/*/LC_MESSAGES/*
331
+ git add dashboard/locale/ docs/locale/ locale/
332
+ git commit -m "Updated translations"
350
333
git push
351
334
352
335
Running Locally with Docker
@@ -364,7 +347,6 @@ Running Locally with Docker
364
347
365
348
4. Run the tests::
366
349
367
- docker compose run --rm web tox
368
350
docker compose run --rm web python -m manage test
369
351
370
352
Pre-commit checks
0 commit comments