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 the Getting-Started guide #215

Merged
merged 5 commits into from
May 25, 2020
Merged

Update the Getting-Started guide #215

merged 5 commits into from
May 25, 2020

Conversation

msmk0
Copy link
Contributor

@msmk0 msmk0 commented May 25, 2020

Update the Getting-started guide in the documentation:

  • Include all (and correct) build options
  • Consistent options help/ ordering in the CMakeLists.txt and in the documentation
  • Update build instructions on lxplus and with a docker container

@msmk0 msmk0 added Improvement Changes to an existing feature Impact - Major Significant bug and/or affects a lot of modules Component - Documentation Affects the documentation labels May 25, 2020
@msmk0 msmk0 added this to the v0.26.00 milestone May 25, 2020
@msmk0 msmk0 requested a review from asalzburger May 25, 2020 13:42
paulgessinger
paulgessinger approved these changes May 25, 2020
View reviewed changes
Copy link
Member

@paulgessinger paulgessinger left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@msmk0 @paulgessinger
Update docs/getting_started.md
3a821f4 
Co-authored-by: Paul Gessinger <[email protected]>
@codecov
Copy link

codecov bot commented May 25, 2020 •
edited
Loading

Codecov Report

Merging #215 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #215   +/-   ##
=======================================
  Coverage   45.00%   45.00%           
=======================================
  Files         374      374           
  Lines       18697    18697           
  Branches     8841     8841           
=======================================
  Hits         8414     8414           
  Misses       4906     4906           
  Partials     5377     5377

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b2ae2fa...3a821f4. Read the comment docs.

@paulgessinger
Copy link
Member

This only touches the docs, the cmake changes only reorder options, so should be fine. The doc build succeeds, so I'm merging this.

@paulgessinger paulgessinger reopened this May 25, 2020
@paulgessinger paulgessinger merged commit 346a3bb into acts-project:master May 25, 2020
@msmk0 msmk0 deleted the docs-getting-started branch June 26, 2020 10:57
paulgessinger added a commit to paulgessinger/acts that referenced this pull request Jul 13, 2020
@msmk0 @paulgessinger
Update the Getting-Started guide (acts-project#215)
06cefbe 
* README: correct section title

* cmake: clean up option order

* docs: update getting started

* cmake: minor doc fixes

* Update docs/getting_started.md

Co-authored-by: Paul Gessinger <[email protected]>

Co-authored-by: Paul Gessinger <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@paulgessinger paulgessinger paulgessinger approved these changes

@asalzburger asalzburger Awaiting requested review from asalzburger

Assignees
No one assigned
Labels
Component - Documentation Affects the documentation Impact - Major Significant bug and/or affects a lot of modules Improvement Changes to an existing feature
Projects
None yet
Milestone
v0.26.00
Development

Successfully merging this pull request may close these issues.
2 participants
@msmk0 @paulgessinger