Skip to content

Added Home lab setup under docs section#122

Open
joyosive wants to merge 1 commit into
sodafoundation:masterfrom
joyosive:soda-lab-setup
Open

Added Home lab setup under docs section#122
joyosive wants to merge 1 commit into
sodafoundation:masterfrom
joyosive:soda-lab-setup

Conversation

@joyosive

Copy link
Copy Markdown

What type of PR is this?
/kind documentation
/kind enhancement

What this PR does / why we need it:
Added SODA Lab setup documentation to help new folks in getting started with SODA testing .

@anvithks anvithks added the documentation Improvements or additions to documentation label Nov 20, 2020
@anvithks anvithks added this to the H-Release milestone Nov 20, 2020
@anvithks

Copy link
Copy Markdown
Member

@joyosive Welcome to the SODA Documentation repository. Thank you for this first PR.

This is a very detailed instruction set on how to setup a homelab.

This PR has details to setup a homelab but it would help if there is one top-level document, right at the start in the SODA Lab Setup page, detailing what a user will be able to do after this SODA Lab setup. What are the different sections and how they can use the different modules.

image

Could you please explain these optional pre-optimisations and what they help with?

  • Optional Pre-optimisations :
    • Pi-Hole Setup
    • Registry Setup
    • Sonatype Nexus Artifactory Setup

What each of these sections does and how they help with SODA Setup?

  • Vagrant Setup
  • Kubernetes Setup
  • Ceph Setup

If you are working on some parts or pages and intend to add more commits to this PR then prefix the title of this PR with [WIP].

  • ESXi Setup
  • Integration of K8s with Ceph via SODA

@anvithks anvithks left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@joyosive Some review comments.
I will add few more when I am able to review the rest of the documents.

weight: 50
disableToc: false
---

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Consider adding a overall summary of Home lab setup letting the user know what all the sections help with and how it helps with SODA Installation.


</div>

- Download the image of ubuntu-20.04 in directory

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

SODA is not fully qualified for Ubuntu 20.04.
Maybe update the steps for Ubuntu 18.04/16.04 and associated changes.


<div class="title">

Important

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Consider using the Notice shortcode. It will help bring out important points in long documents.

| 2 | node1.osive.lab |
| 3 | node2.osive.lab |

[Download files here](../soda-lab-setup/k8s-scripts.zip)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This path points to 404. The zip file is in the same directory as the document. Maybe change to ./k8s-scripts.zip.
Same for other zip files.
Consider placing them in the static folder in the documentation root.

@anvithks anvithks requested review from joseph-v, kumarashit, rajat-soda and skdwriting and removed request for kumarashit November 20, 2020 04:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants