Skip to content
This repository has been archived by the owner on Jan 11, 2023. It is now read-only.

Document orchestrator release and version #3711

Merged
merged 3 commits into from
Aug 21, 2018

Conversation

idanlevin
Copy link
Contributor

What this PR does / why we need it:
It updates the project documentation so people can learn how to use the project quicker

Which issue this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close that issue when PR gets merged): fixes #
N/A

Special notes for your reviewer:
N/A

If applicable:

  • documentation
  • unit tests
  • tested backward compatibility (ie. deploy with previous version, upgrade with this branch)

Release note:
Added documentation for orchestratorRelease and orchestratorVersion

Added documentation for orchestratorRelease and orchestratorVersion
@acs-bot acs-bot added the size/S label Aug 21, 2018
@idanlevin
Copy link
Contributor Author

/assign @brendandburns

@idanlevin
Copy link
Contributor Author

/assign @CecileRobertMichon

@idanlevin
Copy link
Contributor Author

/unassign @brendandburns


Examples for valid values for the orchestrator release: `1.9`, `1.10`, `1.11`, etc.

Examples for valid values for the orchestrator version: `1.9.10`, `1.10.7`, `1.11.2`, etc.
Copy link
Contributor

Choose a reason for hiding this comment

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

this is only true for Kubernetes and supported versions could change overtime. Instead of listing a few hardcoded versions, how about pointing people to the orchestrators command which gives info on supported versions such as:

To learn more about supported orchestrators and versions, run the orchestrators command.

/bin/acs-engine orchestrators

changed examples to use `orchestrators` command
@codecov
Copy link

codecov bot commented Aug 21, 2018

Codecov Report

Merging #3711 into master will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff            @@
##           master   #3711      +/-   ##
=========================================
+ Coverage   55.49%   55.5%   +0.01%     
=========================================
  Files         108     108              
  Lines       16143   16143              
=========================================
+ Hits         8958    8960       +2     
+ Misses       6420    6419       -1     
+ Partials      765     764       -1

Copy link
Contributor

@CecileRobertMichon CecileRobertMichon left a comment

Choose a reason for hiding this comment

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

/lgtm

thanks @idanlevin

@acs-bot acs-bot added the lgtm label Aug 21, 2018
@acs-bot
Copy link

acs-bot commented Aug 21, 2018

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: CecileRobertMichon, idanlevin

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@acs-bot
Copy link

acs-bot commented Aug 21, 2018

New changes are detected. LGTM label has been removed.

@acs-bot acs-bot removed the lgtm label Aug 21, 2018
@CecileRobertMichon CecileRobertMichon merged commit 85d8603 into Azure:master Aug 21, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants