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

Jump to bottom

Update Configuration.md [ci skip] #4959

Merged
merged 8 commits into from
Mar 14, 2023
Merged

Update Configuration.md [ci skip] #4959

merged 8 commits into from
Mar 14, 2023

Conversation

dancesWithCycles
Copy link
Contributor

Hi folks,
I hope this finds you well. Thank you so much for providing and maintaining this repository. Please feel free to study, use, share or improve this pull request for the documentation.

I fixed some typo's in the Configuration.md file.

Cheers!

@dancesWithCycles dancesWithCycles requested a review from a team as a code owner March 9, 2023 13:20
@dancesWithCycles
Copy link
Contributor Author

Hi @leonardehrenfried ,
Thank you for telling me about the doc-templates folder and the mvn test process. Obviously, I was not aware of both of them.

mvn test finished with 0 errors. ;-)

I included PR issue #4960 into this issue #4959.

Do you mind telling the reason for having aligned copies of documentation in either the docs and the doc-templates folder? Is the content of doc-templates release independent and docs release specific?

Cheers!

@dancesWithCycles dancesWithCycles mentioned this pull request Mar 9, 2023
Closed
@codecov
Copy link

codecov bot commented Mar 9, 2023

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (ae986fc) 63.78% compared to head (6f1ea8b) 63.79%.

Additional details and impacted files 
@@            Coverage Diff             @@
##             dev-2.x    #4959   +/-   ##
==========================================
  Coverage      63.78%   63.79%           
- Complexity     13436    13438    +2     
==========================================
  Files           1674     1674           
  Lines          66047    66049    +2     
  Branches        7139     7139           
==========================================
+ Hits           42130    42134    +4     
+ Misses         21528    21527    -1     
+ Partials        2389     2388    -1
Impacted Files Coverage Δ
...m/filterchain/ItineraryListFilterChainBuilder.java 91.74% <100.00%> (ø)
.../filterchain/filter/SameFirstOrLastTripFilter.java 100.00% <100.00%> (ø)

... and 3 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@leonardehrenfried leonardehrenfried changed the title Configuration.md [ci skip] Update Configuration.md [ci skip] Mar 10, 2023
leonardehrenfried
leonardehrenfried approved these changes Mar 10, 2023
View reviewed changes
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.

The reason is that there are lots of parameter tables in the docs which are generated from the code.

This enables the following really nice workflow:

  • change some config parameters in the code
  • run tests
  • documentation is automatically updated

This means that the docs are always in sync with the code which is of course great.

@leonardehrenfried leonardehrenfried removed the request for review from optionsome March 14, 2023 09:48
@vpaturet vpaturet self-requested a review March 14, 2023 09:48
@leonardehrenfried leonardehrenfried merged commit 922df37 into opentripplanner:dev-2.x Mar 14, 2023
@dancesWithCycles dancesWithCycles deleted the Configuration.md branch March 14, 2023 11:56
sjthiessen pushed a commit to HBTGmbH/OpenTripPlanner that referenced this pull request Mar 14, 2023
@dancesWithCycles @sjthiessen
Update Configuration.md [ci skip] (opentripplanner#4959)
49c6391 
* fix: remove typo

* fix: remove typo

* fix: remove typo

* fix: remove typo

* fix: remove typo

* doc: suggest link update

* doc: align docs with doc-templates folder according to PR suggestion

* doc: align docs with doc-templates folder according to PR suggestion
@t2gran t2gran added this to the 2.3 milestone Mar 14, 2023
loj-hbt pushed a commit to HBTGmbH/OpenTripPlanner that referenced this pull request Mar 15, 2023
@dancesWithCycles @loj-hbt
Update Configuration.md [ci skip] (opentripplanner#4959)
427b7b9 
* fix: remove typo

* fix: remove typo

* fix: remove typo

* fix: remove typo

* fix: remove typo

* doc: suggest link update

* doc: align docs with doc-templates folder according to PR suggestion

* doc: align docs with doc-templates folder according to PR suggestion
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vpaturet vpaturet vpaturet approved these changes

@t2gran t2gran t2gran approved these changes

@leonardehrenfried leonardehrenfried leonardehrenfried approved these changes

Assignees
No one assigned
Labels
Documentation Skip Changelog
Projects
None yet
Milestone
2.3
Development

Successfully merging this pull request may close these issues.
4 participants
@dancesWithCycles @leonardehrenfried @t2gran @vpaturet