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

readme: add link to OSRD deployment documentation #7464

Merged
merged 1 commit into from
May 22, 2024
Merged

Conversation

Castavo
Copy link
Contributor

@Castavo Castavo commented May 21, 2024

A person wishing to deploy OSRD today would probably simply read the README and not the article of our website dedicated to deployment.

There is a peculiarity of our stack (setting the ROOT_URL env var, see OpenRailAssociation/osrd-website#199), which needs to be documented somewhere and the website seems to be the best place for it.

@Castavo Castavo requested a review from multun May 21, 2024 10:04
@codecov-commenter
Copy link

codecov-commenter commented May 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 46.14%. Comparing base (772f2ed) to head (b63b3ca).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@              Coverage Diff              @@
##                dev    #7464       +/-   ##
=============================================
+ Coverage     29.34%   46.14%   +16.80%     
=============================================
  Files          1177       47     -1130     
  Lines        145851     2986   -142865     
  Branches       2865        0     -2865     
=============================================
- Hits          42799     1378    -41421     
+ Misses       101368     1608    -99760     
+ Partials       1684        0     -1684     
Flag Coverage Δ
core ?
editoast ?
front ?
gateway 2.41% <ø> (ø)
railjson_generator 87.49% <ø> (ø)
tests ?

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@Castavo Castavo requested a review from bloussou May 21, 2024 11:03
Copy link
Contributor

@flomonster flomonster left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Castavo Castavo added this pull request to the merge queue May 21, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks May 21, 2024
@Castavo Castavo added this pull request to the merge queue May 22, 2024
Merged via the queue into dev with commit fc19888 May 22, 2024
17 checks passed
@Castavo Castavo deleted the bpt/readme-deployment branch May 22, 2024 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants