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.

Sign up for GitHub

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

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

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
dbdebba
Propose a second EWG bidding project: Refactoring of OSM website notes
tordans Oct 4, 2023
e6b895a
Update notes bidding proposal with related information
tordans Oct 5, 2023
ed03957
Apply wording suggestion
tordans Oct 5, 2023
e3874f9
Update notes bidding text to highlight the positive side effects of t…
tordans Oct 27, 2023
7b256d5
Update notes bidding text based on review notes
tordans Oct 29, 2023
6778c14
Fix typo
tordans Oct 29, 2023
72403b6
Text improvements
tordans Oct 29, 2023
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
31 changes: 31 additions & 0 deletions projects/openstreetmap-website-notes-refactoring/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# 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 reasonable by improving the underlying code structure
tordans marked this conversation as resolved.
Show resolved Hide resolved
- 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)

## Side effects

A side effect of this refactoring will be that a recurring error 500 will not be possible anymore, see https://github.com/openstreetmap/openstreetmap-website/issues/2146 for more.

## Possible follow up projects

This refactoring will unblock follow possible follow up improvements to the website and api that are not being worked on ATM due to the outdated foundation of the notes system.

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
- Update the notes UI, related to https://github.com/openstreetmap/openstreetmap-website/pull/3386