diff --git a/Gemfile.lock b/Gemfile.lock index a335cc9f..d5e35b00 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -4,6 +4,7 @@ GEM asciidoctor (2.0.17) PLATFORMS + universal-darwin-23 x86_64-linux DEPENDENCIES diff --git a/Makefile b/Makefile index a8b68c47..6fe95192 100644 --- a/Makefile +++ b/Makefile @@ -3,11 +3,11 @@ all: build .PHONY: build build: clean ## build the site - hugo -t docsy --minify + hugo -F --minify .PHONY: build-preview build-preview: clean ## build a preview, with future-dated content allowed. - hugo -t docsy -F --minify + hugo -F --minify .PHONY: clean clean: ## clean the build assets @@ -17,15 +17,17 @@ clean: ## clean the build assets install: ## install dependencies bundle npm install + hugo mod get + hugo mod graph + hugo mod get github.com/google/docsy .PHONY: netlify -netlify: submodule-init ## build the site for Netlify - git submodule update --init --recursive --depth 1 +netlify: $(MAKE) install $(MAKE) build .PHONY: netlify-preview -netlify-preview: submodule-init ## build a preview of the site for Netlify +netlify-preview: ## build a preview of the site for Netlify $(MAKE) install $(MAKE) build-preview @@ -35,8 +37,4 @@ serve: ## serve the content locally for testing .PHONY: serve-preview serve-preview: ## serve the preview content locally for testing - hugo -t docsy server -F - -.PHONY: submodule-init -submodule-init: - git submodule update --init --recursive --depth 1 + hugo -t docsy server -F \ No newline at end of file diff --git a/assets/img/cncf-logo.png b/assets/img/cncf-logo.png new file mode 100644 index 00000000..a1fa79e9 Binary files /dev/null and b/assets/img/cncf-logo.png differ diff --git a/assets/scss/_styles_project.scss b/assets/scss/_styles_project.scss index eaccb2e6..d581682c 100644 --- a/assets/scss/_styles_project.scss +++ b/assets/scss/_styles_project.scss @@ -6,4 +6,17 @@ img.height-50 { height: 50px; -} \ No newline at end of file +} + +.td-navbar .navbar-brand__name { + display: none; +} + +.td-footer__all_rights_reserved { + display: inline; +} + +.tradem img { + width: 500px; + height: auto; +} diff --git a/config.toml b/config.toml deleted file mode 100644 index 7dc41eba..00000000 --- a/config.toml +++ /dev/null @@ -1,189 +0,0 @@ -baseURL = "/" -title = "Shipwright" - -enableRobotsTXT = true - -# Hugo allows theme composition (and inheritance). The precedence is from left to right. -theme = ["docsy"] - -# Will give values to .Lastmod etc. -enableGitInfo = true - -# Language settings -contentDir = "content/en" -defaultContentLanguage = "en" -defaultContentLanguageInSubdir = false -# Useful when translating. -enableMissingTranslationPlaceholders = true - -disableKinds = ["term", "taxonomy"] - -# Highlighting config -pygmentsCodeFences = true -pygmentsUseClasses = false -# Use the new Chroma Go highlighter in Hugo. -pygmentsUseClassic = false -#pygmentsOptions = "linenos=table" -# See https://help.farbox.com/pygments.html -pygmentsStyle = "tango" - -# Configure how URLs look like per section. -[permalinks] -blog = "/:section/:year/:month/:day/:slug/" - -## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday -[blackfriday] -plainIDAnchors = true -hrefTargetBlank = true -angledQuotes = false -latexDashes = true - -# Image processing configuration. -[imaging] -resampleFilter = "CatmullRom" -quality = 75 -anchor = "smart" - -[services] -[services.googleAnalytics] -# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback]. -# id = "UA-00000000-0" - -# Language configuration - -[languages] - [languages.en] - title = "Shipwright" - languageName ="English" - # Weight used for sorting. - weight = 1 - [languages.en.params] - description = "A framework for building container images on Kubernetes" - -[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" - -# Everything below this are Site Params - -[params] -copyright = "The Shipwright Contributors" -# privacy_policy = "" - -# First one is picked as the Twitter card image if not set on page. -# images = ["images/project-illustration.png"] - -# 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" - -# 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/shipwright-io/website" -# An optional link to a related project repo. For example, the sibling repository where your product code lives. -github_project_repo = "https://github.com/shipwright-io/build" - -# Specify a value here if your content directory is not in your repo's root directory -# github_subdir = "" - -# Google Custom Search Engine ID. Remove or comment out to disable search. -# gcs_engine_id = "011737558837375720776:fsdu1nryfng" - -# Enable Algolia DocSearch -# algolia_docsearch = false - -# Enable Lunr.js offline search -# offlineSearch = false - -# User interface configuration -[params.ui] -# Enable to show the side bar menu in its compact state. -sidebar_menu_compact = false -# 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 -# Set to true to disable the About link in the site footer -footer_about_disable = false - -# 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). -yes = 'Glad to hear it! Please tell us how we can improve.' -no = 'Sorry to hear that. Please tell us how we can improve.' - -# 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://lists.shipwright.io/admin/lists/shipwright-users.lists.shipwright.io/" - icon = "fa fa-envelope" - desc = "Discussion and help from your fellow users" -# [[params.links.user]] -# name ="Twitter" -# url = "https://example.org/twitter" -# 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/shipwright-io/build" - icon = "fab fa-github" - desc = "Contribute to Shipwright!" -[[params.links.developer]] - name = "Slack" - url = "https://kubernetes.slack.com/archives/C019ZRGUEJC" - icon = "fab fa-slack" - desc = "Chat with the Shipwright contributors" -[[params.links.developer]] - name = "Developer mailing list" - url = "https://lists.shipwright.io/admin/lists/shipwright-dev.lists.shipwright.io/" - icon = "fa fa-envelope" - desc = "Discuss development issues around the project" - -[security] - enableInlineShortcodes = false - [security.exec] - allow = ['^dart-sass-embedded$', '^go$', '^npx$', '^postcss$', '^asciidoctor$'] - osEnv = ['(?i)^(PATH|PATHEXT|APPDATA|TMP|TEMP|TERM)$'] - [security.funcs] - getenv = ['^HUGO_'] - [security.http] - methods = ['(?i)GET|POST'] - urls = ['.*'] diff --git a/content/en/_index.html b/content/en/_index.html index 565f03f3..439fb03f 100644 --- a/content/en/_index.html +++ b/content/en/_index.html @@ -1,10 +1,10 @@ +++ title = "Shipwright" linkTitle = "Shipwright" - +++ -{{< blocks/cover title="Shipwright: A framework for building container images on Kubernetes" image_anchor="top" height="full" color="orange" >}} + +{{< blocks/cover title="Shipwright: A framework for building container images on Kubernetes" image_anchor="top" height="full" color="dark">}}
+ +# Contributing Guidelines + +Welcome to Shipwright, we are glad you want to contribute to the project! +This document contains general guidelines for submitting contributions. +Each component of Shipwright will have its own specific guidelines. + +## Contributing prerequisites (CLA/DCO) + +The project enforces [Developer Certificate of Origin (DCO)](https://wiki.linuxfoundation.org/dco). +By submitting pull requests submitters acknowledge they grant the +[Apache License v2](./LICENSE) to the code and that they are eligible to grant this license for all commits submitted in their pull requests. + +## Getting Started + +All contributors must abide by our [Code of Conduct](/CODE_OF_CONDUCT.md). + +The core code for Shipwright is located in the following repositories: + +* [build](https://github.com/shipwright-io/build) - the Build APIs and associated controller to run builds. +* [cli](https://github.com/shipwright-io/cli) - the `shp` command line for Shipwright builds +* [operator](https://github.com/shipwright-io/operator) - an operator to install Shipwright components on Kubernetes via OLM. + +Technical documentation is spread across the code repositories, and is consolidated in the [website](https://github.com/shipwright-io/website) repository. +Content in `website` is published to [shipwright.io](https://shipwright.io) + +## Creating new Issues + +We recommend to open an issue for the following scenarios: + +- Asking for help or questions. (_Use the **discussion** or **help_wanted** label_) +- Reporting a bug. (_Use the **kind/bug** label_) +- Requesting a new feature. (_Use the **kind/feature** label_) + +Use the following checklist to determine where you should create an issue: + +- If the issue is related to how a Build or BuildRun behaves, or related to Build strategies, create an issue in [build](https://github.com/shipwright-io/build). +- If the issue is related to the command line, create an issue in [cli](https://github.com/shipwright-io/cli). +- If the issue is related to how the operator installs Shipwright on a cluster, create an issue in [operator](https://github.com/shipwright-io/operator). +- If the issue is related to the shipwright.io website, create an issue in [website](https://github.com/shipwright-io/website). + +If you are not sure, create an issue in this repository, and the Shipwright maintainers will route it to the correct location. + +If feature request is sufficiently broad or significant, the community may ask you to submit a SHIP enhancement proposal. +Please refer to the [SHIP guidelines](/ships/README.md) to learn how to submit a SHIP proposal. + +## Writing Pull Requests + +Contributions can be submitted by creating a pull request on Github. +We recommend you do the following to ensure the maintainers can collaborate on your contribution: + +- Fork the project into your personal Github account +- Create a new feature branch for your contribution +- Make your changes +- If you make code changes, ensure tests are passing +- Open a PR with a clear description, completing the pull request template if one is provided + Please reference the appropriate GitHub issue if your pull request provides a fix. + +**NOTE**: All commits must be signed-off ([Developer Certificate of Origin (DCO)](https://wiki.linuxfoundation.org/dco)) so make sure you use the `-s` flag when you commit. See more information on signing in [here](https://github.com/apps/dco). + +## Code review process + +Once your pull request is submitted, a Shipwright maintainer should be assigned to review your changes. + +The code review should cover: + +- Ensure all related tests (unit, integration and e2e) are passing. +- Ensure the code style is compliant with the [coding conventions](https://github.com/kubernetes/community/blob/master/contributors/guide/coding-conventions.md) +- Ensure the code is properly documented, e.g. enough comments where needed. +- Ensure the code is adding the necessary test cases (unit, integration or e2e) if needed. + +Contributors are expected to respond to feedback from reviewers in a constructive manner. +Reviewers are expected to respond to new submissions in a timely fashion, with clear language if changes are requested. + +Once the pull request is approved and marked "lgtm", it will get merged. + +## Community Meetings Participation + +We run the community meetings every Monday at 13:00 UTC time. +For each upcoming meeting we generate a new issue where we layout the topics to discuss. +See our [previous meetings](https://github.com/shipwright-io/build/issues?q=is%3Aissue+label%3Acommunity+is%3Aclosed) outcomes. +Please request an invite in our Slack [channel](https://kubernetes.slack.com/archives/C019ZRGUEJC) or join the [shipwright-dev mailing list](https://lists.shipwright.io/admin/lists/shipwright-users.lists.shipwright.io/). + +All meetings are also published on our [public calendar](https://calendar.google.com/calendar/embed?src=shipwright-admin%40lists.shipwright.io&ctz=America%2FNew_York). + +## Contact Information + +- [Slack channel](https://kubernetes.slack.com/archives/C019ZRGUEJC) +- End-user email list: [shipwright-users@lists.shipwright.io](https://lists.shipwright.io/admin/lists/shipwright-users.lists.shipwright.io/) +- Developer email list: [shipwright-dev@lists.shipwright.io](https://lists.shipwright.io/admin/lists/shipwright-dev.lists.shipwright.io/) diff --git a/go.mod b/go.mod new file mode 100644 index 00000000..2e7345d6 --- /dev/null +++ b/go.mod @@ -0,0 +1,5 @@ +module github.com/shipwright-io/website + +go 1.20 + +require github.com/google/docsy v0.10.0 // indirect diff --git a/go.sum b/go.sum new file mode 100644 index 00000000..78bc9349 --- /dev/null +++ b/go.sum @@ -0,0 +1,4 @@ +github.com/FortAwesome/Font-Awesome v0.0.0-20240402185447-c0f460dca7f7/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= +github.com/google/docsy v0.10.0 h1:6tMDacPwAyRWNCfvsn/9qGOZDQ8b0aRzjRZvnZPY5dg= +github.com/google/docsy v0.10.0/go.mod h1:c0nIAqmRTOuJ01F85U/wJPQtc3Zj9N58Kea9bOT2AJc= +github.com/twbs/bootstrap v5.3.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= diff --git a/hugo.yaml b/hugo.yaml new file mode 100644 index 00000000..aa7978b7 --- /dev/null +++ b/hugo.yaml @@ -0,0 +1,204 @@ +baseURL: "https://shipwright.io" +title: "Shipwright" + +# Language settings +contentDir: content/en +defaultContentLanguage: en +defaultContentLanguageInSubdir: false +# Useful when translating. +enableMissingTranslationPlaceholders: true + +enableRobotsTXT: true + +# Will give values to .Lastmod etc. +enableGitInfo: true + +# Comment out to enable taxonomies in Docsy +# disableKinds: [taxonomy, taxonomyTerm] + +# You can add your own taxonomies +taxonomies: + tag: tags + category: categories + +# Highlighting config +pygmentsCodeFences: true +pygmentsUseClasses: false +# Use the new Chroma Go highlighter in Hugo. +pygmentsUseClassic: false +# pygmentsOptions: "linenos=table" +# See https://help.farbox.com/pygments.html +pygmentsStyle: tango + +# Configure how URLs look like per section. +permalinks: + blog: /:section/:year/:month/:day/:slug/ + +# Image processing configuration. +imaging: + resampleFilter: CatmullRom + quality: 75 + anchor: smart + +# Language configuration +languages: + en: + languageName: English + title: Shipwright + params: + description: A framework for building container images on Kubernetes + +markup: + goldmark: + parser: + attribute: + block: true + renderer: + unsafe: true + 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 + +# Comment out if you don't want the "print entire section" link enabled. +outputs: + section: [HTML, print, RSS] + +params: + footer_cncf_note: "We are a Cloud Native Computing Foundation sandbox project." + footer_note: "Kubernetes and the Kubernetes logo are registered trademarks of The Linux Foundation® (TLF)." + footer_cncf_show: true + taxonomy: + # set taxonomyCloud = [] to hide taxonomy clouds + taxonomyCloud: [tags, categories] + + # If used, must have same length as taxonomyCloud + taxonomyCloudTitle: [Tag Cloud, Categories] + + # set taxonomyPageHeader = [] to hide taxonomies on the page headers + taxonomyPageHeader: [tags, categories] + + # First one is picked as the Twitter card image if not set on page. + # images: [images/project-illustration.png] + + # 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 + + + copyright: The Shipwright Contributors + + # 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: v0.13.0 + + # 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/shipwright-io/website + + # An optional link to a related project repo. For example, the sibling repository where your product code lives. + github_project_repo: https://github.com/shipwright-io/build + + # Uncomment this if your GitHub repo does not have "main" as the default branch, + # or specify a new value if you want to reference another branch in your GitHub links + github_branch: main + + # User interface configuration + ui: + # Set to true to disable breadcrumb navigation. + breadcrumb_disable: false + # Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar + navbar_logo: true + # Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage. + navbar_translucent_over_cover_disable: true + # Enable to show the side bar menu in its compact state. + sidebar_menu_compact: 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 + # 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. + feedback: + enable: true + # The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful). + 'yes': >- + Glad to hear it! Please tell us how we can improve. + 'no': >- + Sorry to hear that. Please tell us how we can improve. + # 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 + readingtime: + enable: false + showLightDarkModeMenu: false + + links: + user: + - name: User mailing list + url: https://lists.shipwright.io/admin/lists/shipwright-users.lists.shipwright.io/ + icon: fa fa-envelope + desc: Discussion and help from your fellow users + developer: + - name: GitHub + url: https://github.com/shipwright-io/build + icon: fab fa-github + desc: Contribute to Shipwright! + - name: Slack + url: https://kubernetes.slack.com/archives/C019ZRGUEJC + icon: fab fa-slack + desc: Chat with the Shipwright contributors + - name: Developer mailing list + url: https://lists.shipwright.io/admin/lists/shipwright-dev.lists.shipwright.io/ + icon: fa fa-envelope + desc: Discuss development issues around the project + + + # End user relevant links. These will show up on left side of footer and in the community page if you have one. + footer: + community: + links: + - name: Kubernetes Slack + url: https://kubernetes.slack.com/archives/C019ZRGUEJC + - name: User Mailing List + url: https://lists.shipwright.io/admin/lists/shipwright-users.lists.shipwright.io/ + developer: + links: + - name: How to Contribute + url: https://github.com/shipwright-io/.github/blob/main/CONTRIBUTING.md + - name: Developer Mailing List + url: https://lists.shipwright.io/admin/lists/shipwright-dev.lists.shipwright.io/ + - name: Website Source + url: https://github.com/shipwright-io/website/ + help: + links: + - name: Documentation + url: https://shipwright.io/docs/ + - name: Report a Vulnerability + url: https://github.com/shipwright-io/.github/blob/main/SECURITY.md + policies: + links: + - name: Code of Conduct + url: https://github.com/shipwright-io/.github/blob/main/CODE_OF_CONDUCT.md + - name: Trademark Usage + url: https://www.linuxfoundation.org/legal/trademark-usage + +module: + # uncomment line below for temporary local development of module + # replacements = "github.com/google/docsy -> ../../docsy" + hugoVersion: + extended: true + min: 0.110.0 + imports: + - path: github.com/google/docsy + disable: false \ No newline at end of file diff --git a/i18n/en.toml b/i18n/en.toml index 13b645e7..39b1ac6c 100644 --- a/i18n/en.toml +++ b/i18n/en.toml @@ -2,3 +2,6 @@ [main_license] other = """The Shipwright Contributors | Licensed under CC BY 4.0""" + +[footer_all_rights_reserved] +other = " " diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html index 096ba121..63c44844 100644 --- a/layouts/partials/footer.html +++ b/layouts/partials/footer.html @@ -1,55 +1,15 @@ -{{ $links := .Site.Params.links }} - \ No newline at end of file diff --git a/layouts/partials/footer/center.html b/layouts/partials/footer/center.html new file mode 100644 index 00000000..bcb50b66 --- /dev/null +++ b/layouts/partials/footer/center.html @@ -0,0 +1,14 @@ +
+
+ {{ $cncf := resources.Get "/img/cncf-logo.png" }} +

We are a Cloud Native Computing Foundation sandbox project.

+ opened box +

The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see Trademark Usage.

+
+
+{{ with .Site.Params.copyright -}} +© {{ now.Year }} {{ . }} {{ T "footer_all_rights_reserved" }} +{{- end }} +{{ with .Site.Params.privacy_policy -}} +{{ T "footer_privacy_policy" }} +{{- end }} diff --git a/layouts/partials/footer/left.html b/layouts/partials/footer/left.html new file mode 100644 index 00000000..6a915ddb --- /dev/null +++ b/layouts/partials/footer/left.html @@ -0,0 +1,5 @@ +{{ with .Site.Params.links }} +{{ with index . "user" }} +{{ partial "footer/links.html" . }} +{{ end }} +{{ end }} \ No newline at end of file diff --git a/layouts/partials/footer/links.html b/layouts/partials/footer/links.html new file mode 100644 index 00000000..8388947a --- /dev/null +++ b/layouts/partials/footer/links.html @@ -0,0 +1,9 @@ + \ No newline at end of file diff --git a/layouts/partials/footer/right.html b/layouts/partials/footer/right.html new file mode 100644 index 00000000..8d3a0620 --- /dev/null +++ b/layouts/partials/footer/right.html @@ -0,0 +1,5 @@ +{{ with .Site.Params.links }} +{{ with index . "developer" }} +{{ partial "footer/links.html" . }} +{{ end }} +{{ end }} \ No newline at end of file diff --git a/layouts/partials/navbar.html b/layouts/partials/navbar.html index 93426d13..da4af728 100644 --- a/layouts/partials/navbar.html +++ b/layouts/partials/navbar.html @@ -4,7 +4,7 @@ {{ if .Site.Params.ui.navbar_logo }}{{ with resources.Get "icons/logo.svg" }}{{ end }}{{ end }} -