Moving documentation to Hugo and Docsy

README.md

@@ -1,3 +1,32 @@
+# Nephio documentation
+
+This repository contains the documentation for the Nephio project. 
+
+## Status of the documentation
+
+We are in the middle fo moving the documentation from a GitHub based documentation to a Hugo / Docsy based documentation
+site. The content of this repo (especially this) branch will be a bit chaotic during this time. 
+
+## How to contribute to the documentation
+
+### Setting up the environment
+
+1 The site is using Hugo as the documentation generating engine, therefore you need to install Hugo. As the Docsy
+  template what we use requires the transforming Sass to CSS you will need to install the *extended* version of Hugo.
+  Link to installation instructions is [here](https://gohugo.io/installation/linux/). To ensure that you have the
+  *extended* version of Hugo run `hugo version` the version string should have the word extended in it. (Or `hugo
+  version | grep extended` should not be an empty line.)
+2 Some functions of the theme generation are using NPM packages, therefore NodeJS and NPM will be needed. For
+  compaility reasons a Nove version at least v16.20.2 is needed. To install this version of NodeJS you follow the
+  instructions from [deb.nodesource.com](http://deb.nodesource.com/) and set `NODE_MAJOR=20`.
+3 Install the npm dependencies with `npm install`
+
+### Build the docs locally
+
+To build and see the documentation locally run `hugo serve`. To doublecheck if the site will build on Netifly run `hugo
+--gc --minify`.
+
+
 # Nephio R1
 
 Welcome to the R1 release of Nephio. Please use the documentation links below to

config.toml

@@ -0,0 +1,151 @@
+baseURL = 'https://nephio.org/'
+languageCode = 'en-us'
+title = 'Nephio Documentation'
+# based on https://www.docsy.dev/docs/get-started/docsy-as-module/start-from-scratch/
+
+# Language settings
+contentDir = "content/en"
+defaultContentLanguage = "en"
+defaultContentLanguageInSubdir = false
+enableMissingTranslationPlaceholders = true
+
+
+[module]
+  proxy = "direct"
+  # uncomment line below for temporary local development of module
+  # replacements = "github.com/google/docsy -> ../../docsy"
+  [module.hugoVersion]
+    extended = true
+    min = "0.73.0"
+  [[module.imports]]
+    path = "github.com/google/docsy"
+    disable = false
+  [[module.imports]]
+    path = "github.com/google/docsy/dependencies"
+    disable = false
+
+[markup]
+  [markup.goldmark]
+    [markup.goldmark.renderer]
+      unsafe= true
+    [markup.highlight]
+      # See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
+      style = "tango"
+      # Uncomment if you want your chosen highlight style used for code blocks without a specified language
+      guessSyntax = true
+      # Enable syntax highlighting and copy buttons on code blocks with Prism
+      prism_syntax_highlighting = true      
+
+[params]
+copyright = "The Nephio Authors"
+#privacy_policy = ""
+
+# Menu title if your navbar has a versions selector to access old versions of your site.
+# This menu appears only if you have at least one [params.versions] set.
+version_menu = "Releases"
+
+# Flag used in the "version-banner" partial to decide whether to display a 
+# banner on every page indicating that this is an archived version of the docs.
+# Set this flag to "true" if you want to display the banner.
+archived_version = false
+
+# The version number for the version of the docs represented in this doc set.
+# Used in the "version-banner" partial to display a version number for the 
+# current doc set.
+#version = "0.0"
+version = "latest"
+
+# A link to latest version of the docs. Used in the "version-banner" partial to
+# point people to the main doc site.
+#url_latest_version = "https://example.com"
+
+# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
+github_repo = "https://github.com/nephio-project/docs"
+# An optional link to a related project repo. For example, the sibling repository where your product code lives.
+#github_project_repo = "https://github.com/nephio-project/nephio"
+
+# Specify a value here if your content directory is not in your repo's root directory
+#github_subdir = ""
+
+time_format_blog = "Monday, January 02, 2006"
+time_format_default = "January 2, 2006"
+# Sections to publish in the main RSS feed.
+rss_sections = ["blog"]
+
+# Google Custom Search Engine ID. Remove or comment out to disable search.
+#gcs_engine_id = ""
+
+# Enable Algolia DocSearch
+algolia_docsearch = false
+
+#Enable offline search with Lunr.js
+offlineSearch = false
+offlineSearchSummaryLength = 70
+offlineSearchMaxResults = 10
+
+# User interface configuration
+[params.ui]
+# Enable to show the side bar menu in its compact state.
+sidebar_menu_compact = true
+
+#  Set to true to disable breadcrumb navigation.
+breadcrumb_disable = false
+
+#  Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
+sidebar_search_disable = false
+
+#  Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar
+navbar_logo = true
+
+# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
+# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
+# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
+# add "hide_feedback: true" to the page's front matter.
+[params.ui.feedback]
+enable = true
+
+# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
+# Update with your own repository and response text.
+yes = 'Glad to hear it! Please <a href="https://github.com/nephio-project/nephio/issues/new">tell us how we can improve</a>.'
+no = 'Sorry to hear that. Please <a href="https://github.com/nephio-project/nephio/issuesnew">tell us how we can improve</a>.'
+
+# Adds a reading time to the top of each doc.
+# If you want this feature, but occasionally need to remove the Reading time from a single page, 
+# add "hide_readingtime: true" to the page's front matter
+[params.ui.readingtime]
+enable = false
+
+[params.links]
+# End user relevant links. These will show up on left side of footer and in the community page if you have one.
+# [[params.links.user]]
+#	name = "User mailing list"
+#	url = "https://groups.google.com/forum/#!forum/docsy-users"
+#	icon = "fa fa-envelope"
+#        desc = "Discussion and help from your fellow users"
+#[[params.links.user]]
+#	name ="Twitter"
+#	url = "https://twitter.com/docsydocs"
+#	icon = "fab fa-twitter"
+#        desc = "Follow us on Twitter to get the latest news!"
+# [[params.links.user]]
+	# name = "Stack Overflow"
+	# url = "https://example.org/stack"
+	# icon = "fab fa-stack-overflow"
+        # desc = "Practical questions and curated answers"
+# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
+[[params.links.developer]]
+	name = "GitHub"
+	url = "https://github.com/nephio-project/nephio"
+	icon = "fab fa-github"
+        desc = "Development takes place here!"
+# [[params.links.developer]]
+	# name = "Slack"
+	# url = "https://example.org/slack"
+	# icon = "fab fa-slack"
+        # desc = "Chat with other project developers"
+# [[params.links.developer]]
+	# name = "Developer mailing list"
+	# url = "https://example.org/mail"
+	# icon = "fa fa-envelope"
+        # desc = "Discuss development issues around the project"
+

content/en/_index.md

@@ -0,0 +1,45 @@
+---
+title: Start
+description: Documentation of the Nephio project
+menu: {main: {weight: 10}}
+---
+{{< blocks/cover title="Welcome to the Nephio documentation" image_anchor="top" height="full" >}}
+<a class="btn btn-lg btn-primary me-3 mb-4" href="https://nephio.org/">
+  Homepage <i class="fas fa-arrow-alt-circle-right ms-2"></i>
+</a>
+<a class="btn btn-lg btn-secondary me-3 mb-4" href="https://github.com/nephio-project">
+  GitHub <i class="fab fa-github ms-2 "></i>
+</a>
+<a class="btn btn-lg btn-primary me-3 mb-4" href="/docs/">
+  Documentation <i class="fas fa-arrow-alt-circle-right ms-2"></i>
+</a>
+
+<p class="lead mt-5">Cloud Native Network Automation</p>
+{{< blocks/link-down color="info" >}}
+
+{{< /blocks/cover >}}
+
+{{% blocks/lead color="primary" %}}
+[Nephio project's](https://nephio.org) mission is "to deliver carrier-grade, simple, open, Kubernetes-based cloud native intent automation and
+common automation templates that materially simplify the deployment and management of multi-vendor cloud infrastructure
+and network functions across large scale edge deployments."  
+{{% /blocks/lead %}}
+
+{{% blocks/section type="row" %}}
+
+{{% blocks/feature icon="fas fa-rocket" title="R1" %}}
+Welcome to the R1 release of Nephio. Please use the documenation links below to learn more about Nephio R1, or checkout
+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 %}}
+
+{{% blocks/feature icon="fab fa-wikipedia-w" title="Wiki" %}}
+Mass amount of developer inofrmation is available in the [wiki](https://wiki.nephio.org/).
+{{% /blocks/feature %}}
+
+{{% blocks/feature icon="fas fa-balance-scale-right" title="Charter" %}}
+Technical charter of the project can be found [here](https://nephio.org/wp-content/uploads/sites/6/2022/06/Nephio-Project-Technical-Charter-Amended-6-9-2022.pdf).
+{{% /blocks/feature %}}
+
+
+{{% /blocks/section %}}