Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Propose a second EWG bidding project: Refactoring of OSM website notes #9

Merged
merged 7 commits into from
Nov 9, 2023
Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions projects/openstreetmap-website-notes-refactoring/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# OpenStreetMap-Website: Refactor Notes

The goal of this project is to refactor the existing notes implementation on the OSM website.

* Project: [openstreetmap-website](https://github.com/openstreetmap/openstreetmap-website)
* Related:
- https://github.com/openstreetmap/openstreetmap-website/issues/3831
- maybe https://github.com/openstreetmap/openstreetmap-website/pull/3934

The expected deliverable is a mergeable pull request towards https://github.com/openstreetmap/openstreetmap-website. It must at least:
- Follow the idea of a refactoring by changing as little as possible in behaviour and improving the underlying code structure
- Handle the UI part – Map, Forms, Lists, …
- Handle the API part – without any breaking changes to the API
- Handle the Data migration of existing data – discuss details with the operations team
- Handle freatures related to moderation and administration
tordans marked this conversation as resolved.
Show resolved Hide resolved
tordans marked this conversation as resolved.
Show resolved Hide resolved
- Handle special cases for blocked users, hidden or removed notes and similar cases
- Include a wireframe of all proposed UI changes
- Conform to the [CONTRIBUTING.md doc](https://github.com/openstreetmap/openstreetmap-website/blob/master/CONTRIBUTING.md)

## Positive effects of this project

**Remove bugs and improve stability:**

- There are situations when the Notes API returns an error 500 right now. This refactoring will solve the underlying issue. There are multiple issues and even more dupliactes on this topic, eg. https://github.com/openstreetmap/openstreetmap-website/issues/2146.
tordans marked this conversation as resolved.
Show resolved Hide resolved
- It will also solve edgecases like https://github.com/openstreetmap/openstreetmap-website/issues/3396
tordans marked this conversation as resolved.
Show resolved Hide resolved
- It will make the API more stable and easier to handle for data consumers of the API as well. StreetComplete and NotesReview (https://github.com/ENT8R/NotesReview/issues/113) are two apps that reported related problems.
tordans marked this conversation as resolved.
Show resolved Hide resolved
tordans marked this conversation as resolved.
Show resolved Hide resolved
- It will make proposed workarounds obsolete which will make the code simpler and reduce maintance burdens, eg. https://github.com/openstreetmap/openstreetmap-website/pull/3617, https://github.com/openstreetmap/openstreetmap-website/issues/3744, https://github.com/openstreetmap/openstreetmap-website/pull/3607, https://github.com/openstreetmap/openstreetmap-website/pull/3608

**Solid foundation for follow up projects:**

There are multiple issues discussing additions to the notes system. They all require a solid foundation which this project will provide. For example:

- Add a `source` flag to notes and comments to indicate the app or website that created the note/comment, see https://github.com/openstreetmap/openstreetmap-website/issues/3932
tordans marked this conversation as resolved.
Show resolved Hide resolved
- Extend the API for moderation use cases, see https://github.com/openstreetmap/openstreetmap-website/pull/3934
tordans marked this conversation as resolved.
Show resolved Hide resolved
- Update the list-of-notes-UI, see https://github.com/openstreetmap/openstreetmap-website/pull/3386
tordans marked this conversation as resolved.
Show resolved Hide resolved
- Add tags (or similar) to notes, see for example https://github.com/openstreetmap/openstreetmap-website/issues/3932#issuecomment-1440222022