Website Common Configuration #524
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Apologies for the force push, had somehow not started this branch from |
njtran
reviewed
Jul 22, 2021
geoffcline
suggested changes
Jul 22, 2021
geoffcline
approved these changes
Jul 22, 2021
ellistarn
reviewed
Jul 22, 2021
| ### Marketing and Docs Website | ||
| The Karpenter marketing and docs site uses [Hugo](https://gohugo.io/) and [npm](https://www.npmjs.com/) to generate HTML markup from Markdown content and configuration files in `/website`. Hugo makes use of [`git submodules`](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to bring in theme assets and configruation. The Karpenter website uses the [Docsy theme](https://www.docsy.dev/). To serve this website locally, ensure you have `hugo` and `npm` installed, have initialized and updated your local repository's submodules with `git submodule update --init --recursive`, and then use the follow commands to bring up a local webserver: | ||
| ```bash | ||
| cd website |
There was a problem hiding this comment.
FYI you can do make website
geoffcline
reviewed
Jul 22, 2021
| @@ -79,7 +79,7 @@ helm: ## Generate Helm Chart | |||
| cd charts;helm lint karpenter;helm package karpenter;helm repo index . | |||
|
|
|||
| website: ## Generate Docs Website | |||
| cd website;npm install;hugo -d ../docs | |||
| cd website; npm install; git submodule update --init --recursive; hugo | |||
There was a problem hiding this comment.
that is in the hugo config file now
gfcroft
pushed a commit
to gfcroft/karpenter-provider-aws
that referenced
this pull request
Nov 25, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue, if available:
N/A
Description of changes:
This PR adds common configuration from the Docsy Example site that we'll be leveraging to build the Karpenter docs/landing page.
It combines changes and resolves conflicts from akestner/karpenter:website-landing and geoffcline/karpenter:preview-web so that each of these efforts (building the marketing landing page and technical documentation) can be completed independently and result in PRs that are primarily changes in content, not website config or scaffolding.
Once this is merged, @akestner and @geoffcline should rebase the existing branches, mentioned above, off of the new
HEADof awslabs/karpenter:main to ensure the changes are incorporated and their branches' history is correct.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.