Skip to content
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

Merged
merged 10 commits into from
Jan 11, 2024

Conversation

CsatariGergely
Copy link
Contributor

@CsatariGergely CsatariGergely commented Dec 15, 2023

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:

  • Review the files for broken links, pictures and straightforward language issues
  • Collect feedback on the structure

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>
Copy link
Contributor

nephio-prow bot commented Dec 15, 2023

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

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.

@CsatariGergely CsatariGergely marked this pull request as draft December 15, 2023 10:47
@CsatariGergely
Copy link
Contributor Author

@gvbalaji here is the draft pr for the move to Hugo.

I think we should still need to clarify some structural issues:

  1. I think we should remove the "cover page". It does not add too match to the documentation, but users need to click and extra click to get to the documents. It is there as it is part of the Docsy template.
  2. Now we have a "Guides" section what contains the install, user and contributor guides. Maybe we do not need to have this level.
  3. There are lots of text in the root of the Nephio Install Guides section. I have a feeling that maybe we should move this to an own file.
  4. I tried to order the install guides into a logical order, but I'm not sure if this is the correct order
  5. Nephio User Guides has also lots of text, what maybe should go to a separate file

@electrocucaracha
Copy link
Member

/cc @electrocucaracha

Signed-off-by: Schweier Dominika <dominika.schweier@nokia.com>
Copy link

linux-foundation-easycla bot commented Dec 18, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
@CsatariGergely CsatariGergely changed the title WIP: Moving documentation to Hugo and Docsy Moving documentation to Hugo and Docsy Dec 19, 2023
@CsatariGergely CsatariGergely marked this pull request as ready for review December 19, 2023 11:35
@nephio-prow nephio-prow bot requested a review from henderiw December 19, 2023 11:35
@johnbelamaric
Copy link
Member

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

@nephio-prow nephio-prow bot added the approved label Dec 19, 2023
@johnbelamaric
Copy link
Member

johnbelamaric commented Dec 19, 2023

I wonder if the current https://nephio.org/learn pages should move to this instead of the wiki?

@CsatariGergely
Copy link
Contributor Author

This is totally awesome! Great job. The rendered site looks excellent.

Thanks. There are still a couple of things what we would like to fix, but I think it is a good start.

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?

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.
At the moment this site is connected to the branch in the Nokia fork of the repo and rendered automatically: https://hugo-docs--lighthearted-mermaid-d18bb0.netlify.app/

What we will need to do after the merge:

  • Connect the build to the main branch of this repo
  • Use a redirect of docs.nephio.com to the url of the site
  • Register Nephio at Netifly as an open source project
  • Build some kind of automation to check if the hugo build is successful for the pr-s.

@gvbalaji
Copy link
Contributor

This looks great. Thanks @CsatariGergely
/approve

Copy link
Contributor

nephio-prow bot commented Jan 11, 2024

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@gvbalaji
Copy link
Contributor

/lgtm

@nephio-prow nephio-prow bot added the lgtm label Jan 11, 2024
@nephio-prow nephio-prow bot merged commit d01736f into nephio-project:main Jan 11, 2024
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants