* Update with recent changes from README.md
* Update README.md
This is the final phase of simplifying README.md
- include only Getting started` steps ( These steps were earlier reviewed as part of /docs/QuickStartGuide.md)
- links to a detailed documentation ( the detailed documentation is a copy of the current README.md)
Once this is merged, any new detailed docs should be captured in /docs/detailed-docs.md
* Update detailed-docs.md
Redo the change made in #1873
Co-authored-by: Yusuke Kuoka <[email protected]>
* [Docs] Move into docs folder and other minor fixes
* Move into [docs] folder
* Fix minor formatting
* Create detailed-docs.md
Moving current Readme contents into a separate detailed-docs.md file. Added one additional section "Getting Started" to have the getting started link. Rest of the file is as is from the current Readme.md
This file would be linked from a new simplified Readme (to be raised a separate PR)
* [Doc] Create ARC overview doc
The purpose of this doc is a starting point overview to ARC, with links to Quick start guide within.
* Update Actions-Runner-Controller-Overview.md
Fixed some formatting
* Update for minor formatting
Fixed links to include quotes, where missing. Added spaces after periods, where missing.
* Updated links to the QuickStart guide
* Updated Images and scaling sections
Updated the following based on PR feedback
- `The Runner container image` now calls out more explicitly the recommended way to install additional software
- `Scaling runners - dynamically with Pull Driven ScalingScaling runners - dynamically with Pull Driven Scaling` - Removed mentions of `TotalNumberOfQueuedAndInProgressWorkflowRuns` as its not fully implemented
* Apply suggestions from code review
Incorporated review feedback from @andyfeller, @sethrylan, @debuger24 and @mumoshu. Thank you all.
Co-authored-by: Andy Feller <[email protected]>
Co-authored-by: Rahul Kumar <[email protected]>
Co-authored-by: Seth Rylan Gainey <[email protected]>
Co-authored-by: Yusuke Kuoka <[email protected]>
* Apply suggestions from code review
Add more detailed config for PercentageRunnersBusy metric
Co-authored-by: Yusuke Kuoka <[email protected]>
* Updated link text to "Pull Driven Scaling"
Co-authored-by: Andy Feller <[email protected]>
Co-authored-by: Rahul Kumar <[email protected]>
Co-authored-by: Seth Rylan Gainey <[email protected]>
Co-authored-by: Yusuke Kuoka <[email protected]>
* Create QuickStartGuide.md
Creating a new Quickstart guide that captures simple onboarding instructions. The intent is for first time users to be able to follow this guide and get their environment running and try out ARC. A link to this guide would be added to the repo readme once this PR get merged.
* Update QuickStartGuide.md
Fixed a typo - removed "$" from codeblock "$ kubectl apply -f runnerdeployment.yaml"
* Update QuickStartGuide.md
Eliminated need to specify PAT in Custom_values.yaml. Instead passing as parameter while installing helm chart. This eliminates need to store PAT in a file and also eliminates a setup step.
* Fixed minor typos
Fixed types identified by @nebuk89
* Minor formatting in links and periods.
Fixed formatting to include space after period and commas. Fixed formatting on some links to include quotes
Vijay-train