-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Add Roadmap setup docs #5468
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
Add Roadmap setup docs #5468
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## dev-2.x #5468 +/- ##
==========================================
Coverage 66.80% 66.80%
- Complexity 15557 15559 +2
==========================================
Files 1806 1806
Lines 69821 69821
Branches 7357 7357
==========================================
+ Hits 46643 46647 +4
+ Misses 20720 20718 -2
+ Partials 2458 2456 -2 ☔ View full report in Codecov by Sentry. |
@BredeD can you review this? |
Yes, I will |
I added roadmap issue principles and one image. @AdrianaCeric, the images you added are not shown correctly in Preview mode.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the additions! I left some comments regarding wording and structure. Committing and previewing on desktop will be easier in the long run!
Another section we should include may be how to join a PO meeting
Add descritptions to point 7. Add how to join PO meeting.
@BredeD You can merge this whenever you want. Do you have permissions? |
Need guidance, @AdrianaCeric. I'm in a MaaS meeting just now at NAPCORE Mobility Days. |
@BredeD you can usually merge a PR with a green button on this PR on github.com! Merging is blocked right now because we need two formal approvals. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is ok from my side. You can merge whenever you think it's ready.
The merge process stopped, someone see what went wrong? |
That was because of something unrelated to this PR - I already fixed it. The page has already been deployed: https://docs.opentripplanner.org/en/dev-2.x/Roadmap/ |
Thanks @leonardehrenfried |
When following the link from opentripplanner.org -> Docs, the menu Roacmap is missing. |
When 2.5.0 is released in March '24 it will be part of the default. |
Ok, I see that, hmm, want to get POs to update the website more regularly. Then this is not the best solution. No rush to do something, but is there something to do to make it faster? If yes, we can make a roadmap-issue for it. |
Thanks for merging! |
@leonardehrenfried Maybe we should point the docs-link from openstreetmap.org to the "under development" page? |
I made a PR to the opentripplanner.org website that makes the doc button point to the 2.x dev branch instead of the latest version |
That would definitely solve the problem at hand but will probably create other confusion as people (perhaps justifiably) assume that the default documentation destination relates to the latest stable release of the software. Brede hinted that the POs would like to have more of these pages and update them frequently. If this isn't the case I could, as an exception, just add this one page to the 2.4.0 documentation. |
As I made the change I was wondering if that might be a concern, but the other two links on the page already also point to the dev-2.x branch. I think this is actually more consistent and in line with our intention to keep the 2.x branch operable. |
Summary
Adding documentation regarding how to contribute to OTP's Roadmap.
Issue
No issue; this PR is a follow-up from discussions in the OTP PO meetings and OTP Open Days
My changes here are a starting point, I am open to suggestions from the community!
Q: Should I add a link to the OTP PO meetings so contributers to the Roadmap can discuss their Issues after adding them?
Testing
Please refer to this documentation to start up the mkdocs locally!