Skip to content

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

Merged
merged 6 commits into from
Nov 9, 2023
Merged

Add Roadmap setup docs #5468

merged 6 commits into from
Nov 9, 2023

Conversation

AdrianaCeric
Copy link
Member

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!

@AdrianaCeric AdrianaCeric requested a review from a team as a code owner November 1, 2023 19:15
@AdrianaCeric AdrianaCeric requested a review from a team November 1, 2023 19:16
@AdrianaCeric AdrianaCeric added Documentation Roadmap Create an issue and mention your organization in the title and tag with RoadMap to share your plan labels Nov 1, 2023
Copy link

codecov bot commented Nov 1, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (b0f876e) 66.80% compared to head (4ab6729) 66.80%.
Report is 77 commits behind head on dev-2.x.

❗ Current head 4ab6729 differs from pull request most recent head b466001. Consider uploading reports for the commit b466001 to get more accurate results

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     

see 3 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@leonardehrenfried
Copy link
Member

@BredeD can you review this?

@BredeD
Copy link
Contributor

BredeD commented Nov 2, 2023

Yes, I will

I added roadmap issue principles and one image. 

@AdrianaCeric, the images you added are not shown correctly in Preview mode.
Copy link
Member Author

@AdrianaCeric AdrianaCeric left a 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

BredeD and others added 3 commits November 3, 2023 16:37
Change typo
Add descritptions to point 7.
Add how to join PO meeting.
@leonardehrenfried
Copy link
Member

@BredeD You can merge this whenever you want. Do you have permissions?

@BredeD
Copy link
Contributor

BredeD commented Nov 7, 2023

Need guidance, @AdrianaCeric. I'm in a MaaS meeting just now at NAPCORE Mobility Days.

@AdrianaCeric
Copy link
Member Author

@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.
image

Copy link
Member

@leonardehrenfried leonardehrenfried left a 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.

@BredeD BredeD merged commit ec55557 into dev-2.x Nov 9, 2023
@BredeD BredeD deleted the roadmap-docs branch November 9, 2023 09:52
t2gran pushed a commit that referenced this pull request Nov 9, 2023
@BredeD
Copy link
Contributor

BredeD commented Nov 9, 2023

The merge process stopped, someone see what went wrong?
Is it ok to re-run failed jobs?

@leonardehrenfried
Copy link
Member

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/

@BredeD
Copy link
Contributor

BredeD commented Nov 9, 2023

Thanks @leonardehrenfried

@BredeD
Copy link
Contributor

BredeD commented Nov 9, 2023

When following the link from opentripplanner.org -> Docs, the menu Roacmap is missing.

@leonardehrenfried
Copy link
Member

You need to switch to the newest version of the docs

image

@leonardehrenfried
Copy link
Member

When 2.5.0 is released in March '24 it will be part of the default.

@BredeD
Copy link
Contributor

BredeD commented Nov 9, 2023

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.

@AdrianaCeric
Copy link
Member Author

Thanks for merging!

@BredeD
Copy link
Contributor

BredeD commented Nov 11, 2023

@leonardehrenfried Maybe we should point the docs-link from openstreetmap.org to the "under development" page?

@tsherlockcraig
Copy link
Contributor

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

opentripplanner/opentripplanner.github.io#5

@leonardehrenfried
Copy link
Member

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.

@tsherlockcraig
Copy link
Contributor

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.

@t2gran t2gran added this to the 2.5 (next release) milestone Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Roadmap Create an issue and mention your organization in the title and tag with RoadMap to share your plan
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants