…ect#101)

This PR makes minor changes to the landing page of the documentation to
make the language release neutral.

This PR fixes the "ref" and "relref" links in the documentation so that
they work in Markdown and thus Github. This will mean the links will not
work in the Hugo documentation.

We need to figure out a way to get the links working in both but they
really should work in Github.

The links are now all absolute links in order to pass linkspector and to
work in md.

The linkspector tool fails on any link with a '#' in it, that is a link
to a tag in any document. The change to the .linkspector file is to
remove the '#' character and any following text, thus allowing those
links to pass linkspector.

This PR fixes the image links in the markdown files in the Nephio
documentation. Prior to this PR, the images did not appear whent he
markdown was rendered.

This PR fixes some instructions describe in the Free5GC and OAI user
guides, removes some trail spaces, and simplifies the get logs
instructions.

Signed-off-by: Victor Morales <[email protected]>

Installation guide: Update R1 to R2 
OAI exercice: correct editor

Signed-off-by: Gergely Csatari <[email protected]>

- Adding metallb ip-address pool creation 
- Removing the extra white spaces from network diagram

Remove edge1, edge2 and regional repos in the output from `kubectl get
repositories` command

For R2, free5GC tests moved from `test-infra/e2e/tests` to
`test-infra/e2e/tests/free5gc` directory
- Correct path for yaml files
- Correct file name from 003-network.yaml to 002-network.yaml
- Correct file name from 003-secret.yaml to 002-secret.yaml

Signed-off-by: Victor Morales <[email protected]>

Based on this
[comment](https://discourse.gohugo.io/t/replace-image-reference-link/35314/8)
This will make MD cross reference links work in both Github and Hugo
rendered page.
And Images showing in both.


Note the link at the bottom 
Before:
<img width="532" alt="1"
src="https://github.com/nephio-project/docs/assets/37077655/e4925c1b-3417-4148-9600-b13f9533b3ae">
After:
<img width="532" alt="2"
src="https://github.com/nephio-project/docs/assets/37077655/161e1e5a-82ed-481f-b64c-61d1432618c4">

Note the image:
<img width="532" alt="3"
src="https://github.com/nephio-project/docs/assets/37077655/564629d1-be9f-4816-84f4-79761a4955ec">

---------

Signed-off-by: lapentafd <[email protected]>

Renamed the md file.
Deleted extra steps and added single command for install.
Linked to the manual installation of the kpt packages for the common
components.

---------

Signed-off-by: lapentafd <[email protected]>
Co-authored-by: Fiachra Corcoran <[email protected]>
Co-authored-by: Victor Morales <[email protected]>
Co-authored-by: Kushal Harish Naidu <[email protected]>

Restoring nephio-project#110

So far it is an iframe reference to doc.crds.dev. 

In the long run it might be better to use the
[swaggerui](https://www.docsy.dev/docs/adding-content/shortcodes/#swaggerui)
or the
[redoc](https://www.docsy.dev/docs/adding-content/shortcodes/#redoc)
options of Docsy. For these two later options we would need to have the
Open API specs of the API-s somewhere. I have a feeling that at the
moment we have the API-s defined in Go code and not in Open API. Is this
correct @johnbelamaric ?

Signed-off-by: Gergely Csatari <[email protected]>

This is a contributor guide describing how to use Mockery. It draws
heavily on [PR-441](nephio-project/nephio#441)
raised by @vjayaramrh

---------

Co-authored-by: Victor Morales <[email protected]>

- Focus more on that this is only the source of the documentation
- Replace GitHub link with docs.nephio.org ones
- Add Netlify build status

---------

Signed-off-by: Gergely Csatari <[email protected]>
Co-authored-by: Liam Fallon <[email protected]>
Co-authored-by: Victor Morales <[email protected]>

The current pr contains the user-guide as well as developer-guide for
helm-to-operator-codegen-sdk which is a part of nephio sdk
(https://github.com/nephio-project/nephio-sdk)

---------

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

Signed-off-by: Gergely Csatari <[email protected]>

…project#123)

closes: nephio-project/nephio#589

As discussed in the architecture meeting on Friday, and again in the SIG
Network Architecture meeting today, here is the PR for the architecture
documentation in C4.

---------

Signed-off-by: Alexis de Talhouët <[email protected]>
Co-authored-by: Liam Fallon <[email protected]>
Co-authored-by: Alexis de Talhouët <[email protected]>

nephio-project/nephio#591

According to playbook in test-infra for provisioning, enabling or
disabling KinD cluster shall be achieved by
`kind.enabled` not `kind.enable`
([reference](https://github.com/nephio-project/test-infra/blob/2e8de787693dcfb07f0d2e4088d3ed3ccdac1250/e2e/provision/playbooks/roles/bootstrap/README.md?plain=1#L27)).

However, the document had `kind.enable` which sets up a KinD cluster
that overwrites the current kubeconfig which I had. This seems not to be
an expected behavior.

This PR is the result of the discussion on Nephio TSC channel regarding
the docs licensing. It was confirmed that CC-BY-4.0 license had to be
used and two things had to be changed:

1. Primary LICENSE file
2. SPDX identifier in code files

Quoting verbatim:
---Jenn Bonner (on 21st March 2024)---
Thread regarding the Docs repo incorrect license.
I've heard back from LF Legal. They've done a thorough review, and
recommend the following steps:

1. replace the Apache-2.0 license information in the Documentation repo
2. change all the SPDX identifiers for documentation int hat repo to
CC-BY-4.0 from Apache-2.0
3. Additionally, please have EasyCLA changed so that the documentation
repo is not included in EasyCLA. [DONE]
---

---------

Signed-off-by: Rahul Jadhav <[email protected]>

After some reviews in the modelling (WG4) meetings somewhat of a
consensus has been reached on a view of the Nephio models, and this is
the attempt to describe diagrammatically at a hight level what is
currently there.

---------

Co-authored-by: Fiachra Corcoran <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

Both of them are active participants of the doc team for R3.

Signed-off-by: Gergely Csatari <[email protected]>

This change adds a menu to the documentation pointing to the different
versions of the deployed documentation set.

Partly fixes [#738](nephio-project/nephio#738)

---------

Signed-off-by: Gergely Csatari <[email protected]>

<!--  Thanks for sending a pull request! -->

**What type of PR is this?**
> Uncomment only one ` /kind <>` line, hit enter to put that in a new
line, and remove leading whitespaces from that line:
>
> /kind bug
> /kind cleanup
> /kind design

/kind documentation

> /kind failing-test
> /kind feature
> /kind flake

**What this PR does / why we need it**:
This PR upgrades docsy to 0.10.0 because with the latest version of
Hugo, our documentation build with `hugo serve` fails.

**Which issue(s) this PR fixes**:
Fixes: nephio-project/nephio#751

**Special notes for your reviewer**:
None

**Does this PR introduce a user-facing change?**:
None

Fixes: nephio-project/nephio#495

Signed-off-by: Schweier Dominika <[email protected]>

Fixes: nephio-project/nephio#509

---------

Signed-off-by: Gergely Csatari <[email protected]>

The link of the R3 documentation changed to its final one.

Signed-off-by: Gergely Csatari <[email protected]>

[Usage of H1 headings is not
recommended](google/docsy#2039) therefore
this commit removes them. Table of content was added to some of the
pages, but Docsy generates automatically a ToC to the left side of the
page. Manual maintenance of ToCs is not needed.

Signed-off-by: Gergely Csatari <[email protected]>

This is contingent on, and related to
nephio-project/test-infra#269 so will be
submitted as a draft for the time being. Documenting the additional
variable of K8S_CONTEXT introduced in the linked PR for deploying Nephio
components on non-kind clusters.

Note also that in the "Real K8s Cluster" installation instructions the
branch should be updated once
nephio-project/test-infra#269 is merged and a
new tag is available.

Closes nephio-project/nephio#577

---------

Co-authored-by: Liam Fallon <[email protected]>

Signed-off-by: Alexis de Talhouët <[email protected]>

For the reason of consistent documentation look and feel I've made the
following changes:

- Removal of ToC
- Remval of H1 heading
- Adding newline after headings
- Changing note style
- Adding newline before and after lists

Signed-off-by: Gergely Csatari <[email protected]>

- ToC is displayed for 5 heading levels
- Feedback section removed from the pages
- Bit reorganizing the config file

Signed-off-by: Gergely Csatari <[email protected]>

addresses outstanding comments from
nephio-project#134

Signed-off-by: Alexis de Talhouët <[email protected]>

- 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

---------

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

- Variable ANSIBLE_CMD_EXTRA_VAR_LIST does not work properly

This pr adds the markdown documentation of Porch to docs.nephio.org . 
Open issues are collected in
[here](nephio-project/nephio#744 (comment)).

Fixes nephio-project/nephio#744

---------

Signed-off-by: Gergely Csatari <[email protected]>
Signed-off-by: Schweier Dominika <[email protected]>
Co-authored-by: Liam Fallon <[email protected]>
Co-authored-by: Schweier Dominika <[email protected]>

Closes: nephio-project/nephio#769

---------

Co-authored-by: Rado Chmiel <[email protected]>

Signed-off-by: Schweier Dominika <[email protected]>
Signed-off-by: Gergely Csatari <[email protected]>
Co-authored-by: Gergely Csatari <[email protected]>

- Updating installation and user guide for R3
- I tested the two tutorials on GCP

…ject#155)

Corrected location for architecture guides

See also nephio-project/porch#89

---------

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

…ject#160)

From
https://raw.githubusercontent.com/nephio-project/porch/v3.0.0/docs/adding-external-git-ca-bundle.md

---------

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Michael Greaves <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

The following TODO tasks explicitly mentioned in the text were
completed, thus removed from the docs:
- WSL2 with Docker Desktop setup was checked and working as expected
- `sed` is no longer used as part of the mainstream dev process, and in
the Google-specific parts, where it is still used, it doesn't require
POSIX specific behavior

Signed-off-by: Michael Greaves <[email protected]>

…ct#161)

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

It was removed in nephio-project/porch#107

Signed-off-by: Gergely Csatari <[email protected]>

Now without a token

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

Co-authored-by: Rado Chmiel <[email protected]>

Fixed in-line commands

---------

Signed-off-by: Schweier Dominika <[email protected]>
Signed-off-by: Dominika Schweier <[email protected]>

Co-authored-by: Rado Chmiel <[email protected]>

Co-authored-by: Rado Chmiel <[email protected]>

Signed-off-by: Michael Greaves <[email protected]>

Automatic proofreading

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>

Signed-off-by: Gergely Csatari <[email protected]>