Adding versioning support to R2 #132
Conversation
Signed-off-by: Victor Morales <v.morales@samsung.com>
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 <francesco.lapenta@est.tech>
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 <francesco.lapenta@est.tech> Co-authored-by: Fiachra Corcoran <fiachra.corcoran@est.tech> Co-authored-by: Victor Morales <chipahuac@hotmail.com> Co-authored-by: Kushal Harish Naidu <159911459+kushnaidu@users.noreply.github.com>
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 <gergely.csatari@nokia.com>
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 <chipahuac@hotmail.com>
- 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 <gergely.csatari@nokia.com> Co-authored-by: Liam Fallon <35595825+liamfallon@users.noreply.github.com> Co-authored-by: Victor Morales <chipahuac@hotmail.com>
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 <gergely.csatari@nokia.com>
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
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 <adetalhouet89@gmail.com> Co-authored-by: Liam Fallon <35595825+liamfallon@users.noreply.github.com> Co-authored-by: Alexis de Talhouët <adetalhouet89@gmail.com>
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 <nyrahul@gmail.com>
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 <fiachra.corcoran@est.tech>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
✅ Deploy Preview for nephio-r2 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
content/en/_index.md
Outdated
| our [Learning Nephio with R1](https://wiki.nephio.org/display/HOME/Learning+with+Nephio+R1) series, which includes a | ||
| [demo video](https://youtu.be/mFl71sy2Pdc) and short articles about different aspects of Nephio R1. | ||
| {{% blocks/feature icon="fas fa-rocket" title="R2" %}} | ||
| Welcome to the R2 release of Nephio. Please use the documentation links below to learn more about Nephio R2. | ||
| {{% /blocks/feature %}} | ||
|
|
||
| {{% blocks/feature icon="fab fa-wikipedia-w" title="Wiki" %}} |
There was a problem hiding this comment.
@CsatariGergely It might be a bit out of the scope of this MR, but I suppose we can change the description of the below link from "Mass amount of developer information is available in the [wiki]" to "To know about different Sigs in Nephio you can check out this [wiki]".
There was a problem hiding this comment.
It is outside the scope as with this change I remove all references to the wiki :)
content/en/_index.md
Outdated
| our [Learning Nephio with R1](https://wiki.nephio.org/display/HOME/Learning+with+Nephio+R1) series, which includes a | ||
| [demo video](https://youtu.be/mFl71sy2Pdc) and short articles about different aspects of Nephio R1. | ||
| {{% blocks/feature icon="fas fa-rocket" title="R2" %}} | ||
| Welcome to the R2 release of Nephio. Please use the documentation links below to learn more about Nephio R2. |
There was a problem hiding this comment.
@CsatariGergely Isn't using R2 and release at the same time repetitive?
There was a problem hiding this comment.
Good point. In my head we have a release what is called R2, but I'm happy to change this if it is not clear like this.
How about Welcome to "R2 of Nephio" or "Welcome to release 2 (R2) of Nephio"?
There was a problem hiding this comment.
Sorry for the late reply, "How about Welcome to Release 2 of Nephio" If not then we can use the first one "Welcome to R2 of Nephio"
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
d02482d to
a6d278c
Compare
|
Keywords which can automatically close issues and at(@) or hashtag(#) mentions are not allowed in commit messages. The list of commits with invalid commit messages:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
|
Darn, I was mistakenly merging main in to this R2 pr. |
|
I've created #133 with the same content plus fix for #132 (review) except the main branch merge. |
Redoing #132 now without merging the main branch to the R2 one. Partly fixes nephio-project/nephio#738 --------- Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
No description provided.