Documentation changes in installation and tutorial #315
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ShaunakJoshi1407
added
the
documentation
ShaunakJoshi1407
requested review from
cruizen,
Rohitrajak1807,
jayanth-tjvrr and
bcle
cruizen
previously approved these changes
Nov 17, 2022
ShaunakJoshi1407
force-pushed
the
private/main/shaunak/311
branch
from
0e15ce4
to
a6daed3
Compare
|
Link to the RTD website: https://arlon.readthedocs.io/en/private-main-shaunak-311. I have added docs related to ManagedMachinePool and MachineDeployment cluster creation in the gen2 tutorial. |
Adressed review comments gen2 tutorial Minor refactoring
ShaunakJoshi1407
force-pushed
the
private/main/shaunak/311
branch
from
e18adcb
to
2302e56
Compare
Minor fixes to a few links / formatting
ShaunakJoshi1407
dismissed stale reviews from cruizen and bcle
Added gen2 tutorial after the initial approval
cruizen
approved these changes
Nov 24, 2022
There was a problem hiding this comment.
Approving. But another pair of eyes should approve since I've made many small changes.
cc: @Rohitrajak1807 , @jayanth-tjvrr
Rohitrajak1807
requested changes
Nov 25, 2022
| @@ -130,7 +137,8 @@ ClusterRegistration and associated RBAC rules. | |||
|
|
|||
| The application spec's ApplicationSource points to the existing Arlon Helm chart | |||
| located here by default: | |||
| - Repo: https://github.com/arlonproj/arlon.git | |||
|
|
|||
| - Repo: [https://github.com/arlonproj/arlon.git](https://github.com/arlonproj/arlon.git) | |||
| - Revision: private/leb/gen2 (IMPORTANT: NEEDS TO CHANGE TO STABLE BRANCH OR TAG) | |||
There was a problem hiding this comment.
We might be able to point it to v0.9 tag. @bcle could we do that?
Rohitrajak1807
requested changes
Nov 25, 2022
Rohitrajak1807
approved these changes
Nov 28, 2022
cruizen
added a commit
that referenced
this pull request
Nov 29, 2022
* Doc changes * Added basecluster manifest for AWSManagedMachinePool in docs * Added prerequisite checks for basecluster manifest creation * Reformatting the gen2 tutorial * Adding headings in gen2 tutorial * Minor change in heading * Add note about CAPA version * Change order of validategit and preparegit comands * Adding baseclusters in design.md * Adding requested changes * Many small fixes in docs suggested by yamllint * Many small fixes in docs suggested by yamllint Co-authored-by: Trilok Khairnar <214651+cruizen@users.noreply.github.com> Co-authored-by: Trilok Khairnar <trilok@platform9.com>
cruizen
added a commit
that referenced
this pull request
Nov 29, 2022
* Update ci.yml * Create codecov.yml * Update and expand contributor guide (#330) * add key points * add doc change instructions add workspace slack link (e2e doc link broken) * e2e doc link not broken update pymdown-extensions to 9.9 from 9.8, e2e_testing.md moved to docs dir * Modify basecluster configuration for capa v2.0 (#326) * Modify awsmanagedmachinepool and awsmachinetemplate for capa v2.0 * Change apiVersion for e2e tests * Changing apiVersion for AWSMachinePool * Increaed timeout for assertion in e2e tests * Adding back vibeta1 manifests in configurations.yaml for compatibility with older CAPA versions * Removing debugging from e2e setup script * Bump ArgoCD lib to v2.4.17 (from v2.4.16), k8s libs to v0.23.14 (from v0.23.13), sigs.k8s.io/cluster-api-provider-aws from 1.5.1 to 1.5.2 (#322) * Bump sigs.k8s.io/cluster-api-provider-aws from 1.5.1 to 1.5.2 Bumps [sigs.k8s.io/cluster-api-provider-aws](https://github.com/kubernetes-sigs/cluster-api-provider-aws) from 1.5.1 to 1.5.2. - [Release notes](https://github.com/kubernetes-sigs/cluster-api-provider-aws/releases) - [Commits](kubernetes-sigs/cluster-api-provider-aws@v1.5.1...v1.5.2) --- updated-dependencies: - dependency-name: sigs.k8s.io/cluster-api-provider-aws dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * Update e2e_setup.sh * Update kuttl to v0.14.0 from v0.13.0 * Update kind from v0.14 to v0.17 * Restrict ArgoCD CLI version to 2.4.17 instead of downloading the latest * Bump ArgoCD lib from v2.4.16 to patch v2.4.17, bump k8s libs from v0.23.13 to patch v0.23.14 * fix broken argocd cli dl link * fix broken mv for kuttl Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Trilok Khairnar <214651+cruizen@users.noreply.github.com> Co-authored-by: Trilok Khairnar <trilok@platform9.com> Co-authored-by: Rohitrajak1807 <rrajak@platform9.com> * Documentation changes in installation and tutorial (#315) * Doc changes * Added basecluster manifest for AWSManagedMachinePool in docs * Added prerequisite checks for basecluster manifest creation * Reformatting the gen2 tutorial * Adding headings in gen2 tutorial * Minor change in heading * Add note about CAPA version * Fix order of validategit and preparegit comands * Adding baseclusters in design.md * Many small fixes in docs suggested by markdownlint Co-authored-by: Trilok Khairnar <214651+cruizen@users.noreply.github.com> Co-authored-by: Trilok Khairnar <trilok@platform9.com> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Rohit Rajak <39493074+Rohitrajak1807@users.noreply.github.com> Co-authored-by: Shaunak Joshi <shaunakjoshi1407@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Rohitrajak1807 <rrajak@platform9.com>
cruizen
added a commit
that referenced
this pull request
Dec 16, 2022
* Doc changes * Added basecluster manifest for AWSManagedMachinePool in docs * Added prerequisite checks for basecluster manifest creation * Reformatting the gen2 tutorial * Adding headings in gen2 tutorial * Minor change in heading * Add note about CAPA version * Change order of validategit and preparegit comands * Adding baseclusters in design.md * Adding requested changes * Many small fixes in docs suggested by yamllint * Many small fixes in docs suggested by yamllint Co-authored-by: Trilok Khairnar <214651+cruizen@users.noreply.github.com> Co-authored-by: Trilok Khairnar <trilok@platform9.com>
cruizen
added a commit
that referenced
this pull request
Dec 16, 2022
* Update ci.yml * Create codecov.yml * Update and expand contributor guide (#330) * add key points * add doc change instructions add workspace slack link (e2e doc link broken) * e2e doc link not broken update pymdown-extensions to 9.9 from 9.8, e2e_testing.md moved to docs dir * Modify basecluster configuration for capa v2.0 (#326) * Modify awsmanagedmachinepool and awsmachinetemplate for capa v2.0 * Change apiVersion for e2e tests * Changing apiVersion for AWSMachinePool * Increaed timeout for assertion in e2e tests * Adding back vibeta1 manifests in configurations.yaml for compatibility with older CAPA versions * Removing debugging from e2e setup script * Bump ArgoCD lib to v2.4.17 (from v2.4.16), k8s libs to v0.23.14 (from v0.23.13), sigs.k8s.io/cluster-api-provider-aws from 1.5.1 to 1.5.2 (#322) * Bump sigs.k8s.io/cluster-api-provider-aws from 1.5.1 to 1.5.2 Bumps [sigs.k8s.io/cluster-api-provider-aws](https://github.com/kubernetes-sigs/cluster-api-provider-aws) from 1.5.1 to 1.5.2. - [Release notes](https://github.com/kubernetes-sigs/cluster-api-provider-aws/releases) - [Commits](kubernetes-sigs/cluster-api-provider-aws@v1.5.1...v1.5.2) --- updated-dependencies: - dependency-name: sigs.k8s.io/cluster-api-provider-aws dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * Update e2e_setup.sh * Update kuttl to v0.14.0 from v0.13.0 * Update kind from v0.14 to v0.17 * Restrict ArgoCD CLI version to 2.4.17 instead of downloading the latest * Bump ArgoCD lib from v2.4.16 to patch v2.4.17, bump k8s libs from v0.23.13 to patch v0.23.14 * fix broken argocd cli dl link * fix broken mv for kuttl Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Trilok Khairnar <214651+cruizen@users.noreply.github.com> Co-authored-by: Trilok Khairnar <trilok@platform9.com> Co-authored-by: Rohitrajak1807 <rrajak@platform9.com> * Documentation changes in installation and tutorial (#315) * Doc changes * Added basecluster manifest for AWSManagedMachinePool in docs * Added prerequisite checks for basecluster manifest creation * Reformatting the gen2 tutorial * Adding headings in gen2 tutorial * Minor change in heading * Add note about CAPA version * Fix order of validategit and preparegit comands * Adding baseclusters in design.md * Many small fixes in docs suggested by markdownlint Co-authored-by: Trilok Khairnar <214651+cruizen@users.noreply.github.com> Co-authored-by: Trilok Khairnar <trilok@platform9.com> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Rohit Rajak <39493074+Rohitrajak1807@users.noreply.github.com> Co-authored-by: Shaunak Joshi <shaunakjoshi1407@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Rohitrajak1807 <rrajak@platform9.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: #311 and #310