Commit graph

275 commits

Author SHA1 Message Date
David Larlet
5b9a6500d0
First step for documentation translations
The goal is to be able to embed some of the FAQ entries within the app, see #1710 and #813 for instance.
2024-05-08 21:17:00 -04:00
CampaniaGuy
b6bc821d4d Specified import_pictograms has to be run from main folder. 2024-05-07 13:14:27 +02:00
CampaniaGuy
7b7583dfe6 Docs improvement 2024-05-07 10:03:34 +02:00
CampaniaGuy
1adf6af50c Expanded docker.md documentation 2024-05-07 09:33:41 +02:00
David Larlet
77f284dd8d
chore: bump mkdocs from 1.5.3 to 1.6.0 2024-05-06 13:37:47 -04:00
dependabot[bot]
40950c86ae
chore: bump mkdocs-material from 9.5.18 to 9.5.21
Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 9.5.18 to 9.5.21.
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.18...9.5.21)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-05-06 17:03:57 +00:00
David Larlet
49b240a3db
2.2.2 2024-05-01 14:08:56 -04:00
David Larlet
c05282f19c
2.2.1 2024-05-01 13:36:00 -04:00
Yohan Boniface
22e38d6a3d changelog 2024-05-01 18:13:39 +02:00
Yohan Boniface
55dc083866 i18n 2024-05-01 18:04:01 +02:00
dependabot[bot]
37283a2a4d
chore: bump pymdown-extensions from 10.8 to 10.8.1
Bumps [pymdown-extensions](https://github.com/facelessuser/pymdown-extensions) from 10.8 to 10.8.1.
- [Release notes](https://github.com/facelessuser/pymdown-extensions/releases)
- [Commits](https://github.com/facelessuser/pymdown-extensions/compare/10.8...10.8.1)

---
updated-dependencies:
- dependency-name: pymdown-extensions
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-04-29 17:19:17 +00:00
Yohan Boniface
9478b0c248 changelog 2024-04-24 21:35:31 +02:00
dependabot[bot]
1cd24845b4
chore: bump pymdown-extensions from 10.7.1 to 10.8
Bumps [pymdown-extensions](https://github.com/facelessuser/pymdown-extensions) from 10.7.1 to 10.8.
- [Release notes](https://github.com/facelessuser/pymdown-extensions/releases)
- [Commits](https://github.com/facelessuser/pymdown-extensions/compare/10.7.1...10.8)

---
updated-dependencies:
- dependency-name: pymdown-extensions
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-04-22 17:30:41 +00:00
dependabot[bot]
d62fda635e
chore: bump mkdocs-material from 9.5.16 to 9.5.18
Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 9.5.16 to 9.5.18.
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.16...9.5.18)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-04-16 14:40:57 +00:00
dependabot[bot]
1f0b5dcc6e
chore: bump mkdocs-material from 9.5.15 to 9.5.16
Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 9.5.15 to 9.5.16.
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.15...9.5.16)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-04-01 17:29:20 +00:00
28d7cff747 [docs] update the "testing" contributing section
It now includes the new commands.
2024-04-01 11:12:44 +02:00
Yohan Boniface
cf61495815 changelog 2024-03-27 22:26:54 +01:00
Yohan Boniface
4fcda97293
Merge pull request #1709 from umap-project/dependabot/pip/mkdocs-material-9.5.15
chore: bump mkdocs-material from 9.5.14 to 9.5.15
2024-03-25 21:00:51 +01:00
Yohan Boniface
db2a0bc74f changelog 2024-03-25 20:18:00 +01:00
dependabot[bot]
56708bbd30
chore: bump mkdocs-material from 9.5.14 to 9.5.15
Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 9.5.14 to 9.5.15.
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.14...9.5.15)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-03-25 17:42:11 +00:00
Yohan Boniface
288c7983fc fix: Path.replace called instead str.replace 2024-03-25 14:40:48 +01:00
Yohan Boniface
8d9468df00 2.1.0 2024-03-25 13:55:08 +01:00
David Larlet
985483b7d0
Initiate changelog for 2.1.0 2024-03-22 12:19:58 -04:00
dependabot[bot]
82002fea0a
chore: bump mkdocs-material from 9.5.13 to 9.5.14
Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 9.5.13 to 9.5.14.
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.13...9.5.14)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-03-18 17:27:23 +00:00
dependabot[bot]
d1c59a3e78
chore: bump pymdown-extensions from 10.7 to 10.7.1
Bumps [pymdown-extensions](https://github.com/facelessuser/pymdown-extensions) from 10.7 to 10.7.1.
- [Release notes](https://github.com/facelessuser/pymdown-extensions/releases)
- [Commits](https://github.com/facelessuser/pymdown-extensions/compare/10.7...10.7.1)

---
updated-dependencies:
- dependency-name: pymdown-extensions
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-03-15 13:36:14 +00:00
dependabot[bot]
0e142eddc2
chore: bump mkdocs-material from 9.5.12 to 9.5.13
Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 9.5.12 to 9.5.13.
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.12...9.5.13)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-03-11 17:51:40 +00:00
dependabot[bot]
a08cc251cf
chore: bump mkdocs-material from 9.5.11 to 9.5.12
Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 9.5.11 to 9.5.12.
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.11...9.5.12)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-03-04 17:16:00 +00:00
Yohan Boniface
c658b28f6e 2.0.4 2024-03-01 18:18:07 +01:00
Yohan Boniface
2a2e237c0e changelog 2024-03-01 18:01:37 +01:00
dependabot[bot]
82c92dabff
chore: bump mkdocs-material from 9.5.10 to 9.5.11
Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 9.5.10 to 9.5.11.
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.10...9.5.11)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-02-26 17:49:20 +00:00
David Larlet
69df1bb092
Merge pull request #1632 from umap-project/fix-docs-l-u
docs: update namespace of uMap objects
2024-02-20 08:23:22 -05:00
David Larlet
db451acccf
Merge pull request #1633 from umap-project/docs-docker
docs: add a note for Docker install and SECRET_KEY
2024-02-20 08:23:11 -05:00
Yohan Boniface
0de52cd1f6 docs: fix bad rendering in settings 2024-02-20 08:55:00 +01:00
dependabot[bot]
85d73834ff
chore: bump mkdocs-material from 9.5.7 to 9.5.10
Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 9.5.7 to 9.5.10.
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.7...9.5.10)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-02-20 07:34:22 +00:00
David Larlet
16e7991a3d
docs: add a note for Docker install and SECRET_KEY
Refs #1618
2024-02-19 17:46:13 -05:00
David Larlet
35acbde4e2
docs: update namespace of uMap objects 2024-02-19 17:11:10 -05:00
David Larlet
875c7c4c69
fix: Do not use compress anymore for Docker image
Fixes #1619
2024-02-18 10:22:24 -05:00
David Larlet
71febbaf3f
Getting ready for 2.0.0 2024-02-16 11:27:14 -05:00
Yohan Boniface
1db2455d51 chore: replace settings.FROM_EMAIL by settings.DEFAULT_FROM_EMAIL
DEFAULT_FROM_EMAIL is a Django standard setting
2024-02-16 11:49:38 +01:00
Yohan Boniface
97a54b898c changelog 2024-02-15 15:01:58 +01:00
Yohan Boniface
a99ee90e15 chore: migrate to OAuth 2 for OpenStreetMap backend
fix #1279
2024-02-14 11:30:16 +01:00
Yohan Boniface
246c0eef18 changelog 2024-02-13 17:54:15 +01:00
Yohan Boniface
453a242e6a docs: mention to run a collectstatic in the release process
Just to test it before running it in the servers.
2024-02-09 18:41:04 +01:00
Yohan Boniface
5da032973a 2.0.0a0 2024-02-09 18:23:59 +01:00
Yohan Boniface
991657f3ea docs: mention OSM fr deployment process 2024-02-09 14:48:10 +01:00
Yohan Boniface
29e2d214a5 docs: fix link in index.md 2024-02-09 14:42:27 +01:00
David Larlet
3468a77ce7
Merge pull request #1569 from umap-project/sentry
feat: Adding Sentry errors reporter support
2024-02-07 09:35:52 -05:00
David Larlet
f31a2f414a
docs: customizing header/footer templates 2024-02-06 12:56:09 -05:00
dependabot[bot]
2e960a8d1d
chore: bump pymdown-extensions from 10.4 to 10.7
Bumps [pymdown-extensions](https://github.com/facelessuser/pymdown-extensions) from 10.4 to 10.7.
- [Release notes](https://github.com/facelessuser/pymdown-extensions/releases)
- [Commits](https://github.com/facelessuser/pymdown-extensions/compare/10.4...10.7)

---
updated-dependencies:
- dependency-name: pymdown-extensions
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-02-05 19:49:41 +00:00
dependabot[bot]
9352271232
chore: bump mkdocs-material from 9.4.14 to 9.5.7
Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 9.4.14 to 9.5.7.
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.4.14...9.5.7)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-02-05 17:52:13 +00:00
David Larlet
c3691b235e
docs: define an explicit release stragegy 2024-01-29 13:30:13 -05:00
Yohan Boniface
caeb9d5b44
Merge pull request #1531 from umap-project/home-highlighted
Introduce UMAP_HOME_FEED to control which maps are shown on the home page
2024-01-29 12:48:24 +01:00
Yohan Boniface
01083516bd changelog 2024-01-25 17:05:38 +01:00
Yohan Boniface
541fbd4e56 docs: remove mentions of compress / django-compressor 2024-01-19 17:16:38 +01:00
Yohan Boniface
9f377da1b2 Introduce UMAP_HOME_FEED to control which maps are shown on the home page
For now we have only three modes:
- latest, which is the default and shows the last updated maps
- highlighted, which shows only the map that have been starred by a least
  one staff member
- None, which does not show any map
2024-01-16 12:31:50 +01:00
3e63768fc0 docs: clarify how to use JS libs 2024-01-15 14:58:43 +01:00
de8e806b28 docs: document how dependencies are handled 2024-01-15 14:44:55 +01:00
Yohan Boniface
4c5b94d572
Merge pull request #1511 from umap-project/docs/template-changes
docs: document changed templates
2024-01-13 18:52:09 +01:00
b75e3bedd7 docs: include the release process 2024-01-11 11:56:13 +01:00
Stephan Geisler
e40d4584f9 fix typo in settings.md 2024-01-11 11:48:48 +01:00
Stephan Geisler
2c94f6afbe Update settings.md
Description added on how to create a superuser in order to be able to use the ENABLE_ACCOUNT_LOGIN parameter (result of issue: #1520)
2024-01-11 11:48:48 +01:00
Yohan Boniface
20814dd73c changelog 2024-01-08 16:52:56 +01:00
aef8afee6c docs: document changed templates 2024-01-08 16:51:41 +01:00
Yohan Boniface
16a42025b5 changelog 2024-01-08 13:51:14 +01:00
Yohan Boniface
1d32e52386 Refactor changelog 2023-12-29 11:38:13 +01:00
Yohan Boniface
defb956e7e changelog 2023-12-29 11:25:24 +01:00
David Larlet
f034477e08
Fix the changelog for mkdocs rendering 2023-12-26 10:39:23 -05:00
Yohan Boniface
5f744848ac changelog 2023-12-23 09:20:45 +01:00
Yohan Boniface
45f0fdc03f changelog 2023-12-17 10:11:53 +01:00
f3c67b54b6 [docs] Add some testing information 2023-12-15 17:00:50 +00:00
David Larlet
1fccbb7d59
Better changelog rendering 2023-12-06 12:46:32 -05:00
d15c436d42 [chore] fix docs requirements 2023-12-06 11:04:15 +00:00
e4ad904536
Merge pull request #1440 from umap-project/almet/rework-docs 2023-12-06 10:40:24 +00:00
ce4b411cec
Update docs/contributing.md
Co-authored-by: Yohan Boniface <yb@enix.org>
2023-12-05 23:13:27 +01:00
b04ad69276
Update docs/config/settings.md
Co-authored-by: Yohan Boniface <yb@enix.org>
2023-12-05 23:12:40 +01:00
18afcad918
Update docs/config/customize.md
Co-authored-by: Yohan Boniface <yb@enix.org>
2023-12-05 23:12:28 +01:00
4676fd09e6
Update docs/architecture/overview.md
Co-authored-by: Yohan Boniface <yb@enix.org>
2023-12-05 23:12:09 +01:00
c058db8ae2 [docs] Rework the documentation 2023-12-05 16:18:10 +01:00
David Larlet
8804a953ee
[docs] Adapt primary color to match uMap one 2023-11-28 21:40:09 -05:00
b3d6d6da08 [docs] Update the documentation 2023-11-28 15:54:11 +01:00
Yohan Boniface
3c3a99ba6e changelog 2023-11-27 10:24:00 +01:00
Yohan Boniface
fc64551c82 Add in documentation example of filtering headers in ajax proxy conf 2023-11-23 17:03:16 +01:00
Yohan Boniface
a77a6a137f Update search index command in documentation
Sadly, when using a SearchVector, Django will introduce a COALESCE
that will then prevent our index to be used. So we need to add
this COALESCE in the index to make psql happy.

fix #1414
2023-11-21 10:40:55 +01:00
Yohan Boniface
173c1315a4 Fix documentation formating 2023-11-21 10:28:27 +01:00
Yohan Boniface
66ee9c736e changelog 2023-11-20 11:38:53 +01:00
Yohan Boniface
3034ebc50b
Merge pull request #1388 from umap-project/pictogram-category
Pictogram category
2023-11-07 18:01:15 +01:00
4f00981293 Update installation instructions 2023-11-06 12:15:05 +01:00
Yohan Boniface
de8bbc2851
Update docs/administration.md
Co-authored-by: David Larlet <3556+davidbgk@users.noreply.github.com>
2023-10-30 22:28:15 +01:00
Yohan Boniface
15eea6ead9
Apply suggestions from code review
Co-authored-by: David Larlet <3556+davidbgk@users.noreply.github.com>
2023-10-30 21:51:05 +01:00
Yohan Boniface
f61f1415ce Update pictograms import script to deal with category and SVG 2023-10-30 21:35:22 +01:00
Yohan Boniface
c9f767b6de changelog 2023-10-27 20:12:38 +02:00
Yohan Boniface
2bca26cbe7 changelog 2023-10-18 09:16:42 +02:00
Yohan Boniface
ddbcdbcde7 changelog 2023-10-12 11:47:04 +02:00
Yohan Boniface
5f9d7d3ec3 changelog 2023-10-12 10:14:57 +02:00
Yohan Boniface
07031595e7 changelog 2023-10-12 09:23:45 +02:00
Yohan Boniface
4e3a22dc11 changelog 2023-09-27 07:28:03 +02:00
David Larlet
3d2a1d96fd
Changelog 2023-09-22 14:58:33 -04:00
David Larlet
f11ef754c4
changelog 2023-09-22 12:33:19 -04:00
Yohan Boniface
0988f2e2ee
Merge pull request #1320 from jvmatl/docker_quickstart_docs
A more newbie-friendly Docker HOWTO
2023-09-20 18:36:05 +02:00
John Martinez
7e2b20d085
Update docs/docker.md
Co-authored-by: Yohan Boniface <yohanboniface@free.fr>
2023-09-20 12:07:58 -04:00