Re-arranging the documentation #148

arora-sagar · 2024-06-30T09:38:55Z

Added how to create a repo
Secret for git repo required by Nephio controller

Tested single VM and multiple VM steps.

This PR is addressing nephio-project/nephio#592

- Added how to create a repo - Secret for git repo

netlify · 2024-06-30T09:39:16Z

✅ Deploy Preview for nephio ready!

Name	Link
🔨 Latest commit	`68f4761`
🔍 Latest deploy log	https://app.netlify.com/sites/nephio/deploys/6682c0fec025090008e14e32
😎 Deploy Preview	https://deploy-preview-148--nephio.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

arora-sagar · 2024-06-30T09:44:53Z

@vjayaramrh and @dkosteck please check if you are fine with my edit. Instead of using the term Real K8s I have changed it to Other K8s Distributions because the term real is misleading. Even other Other K8s Distributions is not the best choice but it's better than real.

liamfallon

/approve

content/en/docs/guides/_index.md

Co-authored-by: Gergely Csatari <[email protected]>

vjayaramrh · 2024-07-01T13:24:04Z

content/en/docs/guides/install-guides/_index.md

@@ -93,7 +96,7 @@ sudo NEPHIO_DEBUG=false   \
     bash
 ```

-**Real K8s Cluster**
+**Other K8s Distributions**


How about Pre-installed K8S clusters instead of Other K8s Distributions?

I tend to agree, "Other" may also be ambiguous, so perhaps something along the lines of what @vjayaramrh suggested

Okay sounds good, I will change it

dkosteck

Hello @arora-sagar, I have added some suggestions that I think help with readability, some spelling/capitalization, etc. Feel free to disagree with them if you think it reads fine now. I also commented on Vish's response to "Real" clusters, and a clarifying question

dkosteck · 2024-07-01T13:47:55Z

content/en/docs/guides/install-guides/_index.md

@@ -93,7 +96,7 @@ sudo NEPHIO_DEBUG=false   \
     bash
 ```

-**Real K8s Cluster**
+**Other K8s Distributions**


I tend to agree, "Other" may also be ambiguous, so perhaps something along the lines of what @vjayaramrh suggested

dkosteck · 2024-07-01T14:00:05Z

content/en/docs/guides/install-guides/install-on-multiple-vm.md

+
+If you want to use Github or Gitlab then follow below steps
+
+Get a [GitHub token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#fine-grained-personal-access-tokens) if your repository is private, or allow Porch to make modifications.


I'm confused by the "or allow Porch to make modifications" portion of this step. Perhaps it's me being newer and not understanding, but should there be some clarification here? How would that be done?

I left it how it was earlier, I suppose it should be "to allow Porch to make modifications"

Right, I think that probably makes more sense in this context

content/en/docs/guides/install-guides/install-on-multiple-vm.md

content/en/docs/guides/install-guides/install-on-single-vm.md

content/en/docs/guides/install-guides/common-components.md

content/en/docs/guides/install-guides/_index.md

content/en/docs/guides/_index.md

- Changing from other k8s distributions to pre-installed

arora-sagar · 2024-07-01T14:46:52Z

Hello @arora-sagar, I have added some suggestions that I think help with readability, some spelling/capitalization, etc. Feel free to disagree with them if you think it reads fine now. I also commented on Vish's response to "Real" clusters, and a clarifying question

@dkosteck I have resolved the conversation for the changes you have suggested. Let me know if there is something left.

dkosteck · 2024-07-01T14:51:42Z

Hello @arora-sagar, I have added some suggestions that I think help with readability, some spelling/capitalization, etc. Feel free to disagree with them if you think it reads fine now. I also commented on Vish's response to "Real" clusters, and a clarifying question

@dkosteck I have resolved the conversation for the changes you have suggested. Let me know if there is something left.

Looks good. Thanks!

CsatariGergely · 2024-07-01T14:56:40Z

/approve

arora-sagar · 2024-07-01T14:56:41Z

@CsatariGergely Can we merge it now?

nephio-prow · 2024-07-01T14:56:45Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: CsatariGergely, liamfallon

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:

~~OWNERS~~ [CsatariGergely,liamfallon]

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

CsatariGergely · 2024-07-01T14:58:54Z

Fixes: nephio-project/nephio#592

vjayaramrh · 2024-07-01T15:06:10Z

/lgtm

vjayaramrh · 2024-07-01T15:08:09Z

content/en/docs/guides/install-guides/install-on-multiple-vm.md

 ```bash
 export NEPHIO_USER=$USER
-export ANSIBLE_CMD_EXTRA_VAR_LIST="k8s.context=[email protected] kind.enabled=false host_min_vcpu=4 host_min_cpu_ram=8"
+export ANSIBLE_CMD_EXTRA_VAR_LIST="k8s.context=kind-kind kind.enabled=false host_min_vcpu=4 host_min_cpu_ram=8"


@arora-sagar Is this captured in a the user provided environment varaibles table?

@vjayaramrh This was already there I did add it, though I tried to run the script and frankly I failed so I am not sure if it is correct.

Re-arranging the documentation

57faca0

- Added how to create a repo - Secret for git repo

nephio-prow bot requested review from efiacor and tliron June 30, 2024 09:38

arora-sagar requested review from johnbelamaric and removed request for tliron and efiacor June 30, 2024 09:39

arora-sagar requested review from CsatariGergely and liamfallon June 30, 2024 09:39

arora-sagar assigned CsatariGergely Jun 30, 2024

arora-sagar added the documentation Improvements or additions to documentation label Jun 30, 2024

liamfallon reviewed Jul 1, 2024

View reviewed changes

nephio-prow bot added the approved label Jul 1, 2024

CsatariGergely suggested changes Jul 1, 2024

View reviewed changes

content/en/docs/guides/_index.md Outdated Show resolved Hide resolved

content/en/docs/guides/_index.md Outdated Show resolved Hide resolved

arora-sagar and others added 2 commits July 1, 2024 15:01

Update content/en/docs/guides/_index.md

a5f0726

Co-authored-by: Gergely Csatari <[email protected]>

Update content/en/docs/guides/_index.md

9390eb0

Co-authored-by: Gergely Csatari <[email protected]>

vjayaramrh reviewed Jul 1, 2024

View reviewed changes

dkosteck suggested changes Jul 1, 2024

View reviewed changes

arora-sagar added 2 commits July 1, 2024 16:24

reviewer suggestion to improve naming

47ea8e4

- Changing from other k8s distributions to pre-installed

correct capitalization and grammatical errors

68f4761

nephio-prow bot assigned vjayaramrh Jul 1, 2024

nephio-prow bot added the lgtm label Jul 1, 2024

nephio-prow bot merged commit 4a231a1 into nephio-project:main Jul 1, 2024
8 checks passed

vjayaramrh reviewed Jul 1, 2024

View reviewed changes

CsatariGergely mentioned this pull request Jul 1, 2024

Docs for installation guides need a little re-org nephio-project/nephio#592

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Re-arranging the documentation #148

Re-arranging the documentation #148

arora-sagar commented Jun 30, 2024 •

edited

Loading

netlify bot commented Jun 30, 2024 •

edited

Loading

arora-sagar commented Jun 30, 2024 •

edited

Loading

liamfallon left a comment

vjayaramrh Jul 1, 2024

dkosteck Jul 1, 2024

arora-sagar Jul 1, 2024

dkosteck left a comment

dkosteck Jul 1, 2024

dkosteck Jul 1, 2024

arora-sagar Jul 1, 2024

dkosteck Jul 1, 2024

arora-sagar commented Jul 1, 2024

dkosteck commented Jul 1, 2024

CsatariGergely commented Jul 1, 2024

arora-sagar commented Jul 1, 2024

nephio-prow bot commented Jul 1, 2024

CsatariGergely commented Jul 1, 2024 •

edited

Loading

vjayaramrh commented Jul 1, 2024

vjayaramrh Jul 1, 2024

arora-sagar Jul 1, 2024


		If you want to use Github or Gitlab then follow below steps

		Get a [GitHub token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#fine-grained-personal-access-tokens) if your repository is private, or allow Porch to make modifications.

Re-arranging the documentation #148

Re-arranging the documentation #148

Conversation

arora-sagar commented Jun 30, 2024 • edited Loading

netlify bot commented Jun 30, 2024 • edited Loading

✅ Deploy Preview for nephio ready!

arora-sagar commented Jun 30, 2024 • edited Loading

liamfallon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dkosteck left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arora-sagar commented Jul 1, 2024

dkosteck commented Jul 1, 2024

CsatariGergely commented Jul 1, 2024

arora-sagar commented Jul 1, 2024

nephio-prow bot commented Jul 1, 2024

CsatariGergely commented Jul 1, 2024 • edited Loading

vjayaramrh commented Jul 1, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arora-sagar commented Jun 30, 2024 •

edited

Loading

netlify bot commented Jun 30, 2024 •

edited

Loading

arora-sagar commented Jun 30, 2024 •

edited

Loading

CsatariGergely commented Jul 1, 2024 •

edited

Loading