-
Notifications
You must be signed in to change notification settings - Fork 28
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Moving documentation to Hugo and Docsy #76
Conversation
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
- Move developer guide to the new structure - Adding logo with white letters - Correcting go.mod - Update README to show how to set up a work environment to modify the documentation Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
Hi @CsatariGergely. Thanks for your PR. I'm waiting for a nephio-project member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. 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. |
@gvbalaji here is the draft pr for the move to Hugo. I think we should still need to clarify some structural issues:
|
Signed-off-by: Schweier Dominika <dominika.schweier@nokia.com>
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
This is totally awesome! Great job. The rendered site looks excellent. How will this work once it merges, as far as where/how we update the docs, and how they get compiled and up and running on the docs site? /approve |
I wonder if the current https://nephio.org/learn pages should move to this instead of the wiki? |
Thanks. There are still a couple of things what we would like to fix, but I think it is a good start.
We keep updating the docs in this repo, but we will need to add some hugo specific annotations to the .md files we create. They are compiled and hosted by Netifly automatically. What we will need to do after the merge:
|
This looks great. Thanks @CsatariGergely |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: gvbalaji, johnbelamaric 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:
Approvers can indicate their approval by writing |
/lgtm |
This pr moves the documentation from plain md files rendered in GitHub to Hugo and the Docsy theme.
The plan is to get the documentation published on Netifly and assign https://docs.nephio.org with the end result.
The source branch is rendered here
TODO: