-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
Migrate website to Hugo #2342
Migrate website to Hugo #2342
Conversation
|
Thanks! Let me see if I can get netlify updated so we can compare |
|
@dmcgowan I can add a Netlify configuration that should solve the current issue. |
docs/netlify.toml
Outdated
| @@ -0,0 +1,13 @@ | |||
| [build] | |||
| publish = "public" | |||
| command = "make build" | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the source directory has to be set, the command gets run from root. Not sure if this file also has to be in the root.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like the Netlify config allows for a non-root directory, which seems better to me than having the website config in the root.
|
@dmcgowan It looks like Netlify is still trying to build the site as a Jekyll site. There may be necessary configuration changes in the Netlify web UI. Could you check? |
|
Not sure how to get it to respect the toml file, updated to hugo and rebuilt. |
| @@ -0,0 +1,7 @@ | |||
| - OCI Image Spec support | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like a map expected here cannot unmarshal !!seq into map[string]interface {}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Weird. That works just fine locally. I'll look into it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Works locally for me as well, it appears to be running the command I set on the project rather than from the toml. I don't know what version of hugo it is running.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My bad, I needed to set that environment variable, build working now
|
Works, site looks good. Can you sign/squash some of the commits and remove the |
|
The only thing missing in the new version is the text right under the logo. Compare https://5afa1bdedd6a546d33baef24--musing-einstein-7cc486.netlify.com/ vs https://containerd.io/ |
|
My bad. Fixed. I can squash the commits later this evening. |
|
also make sure the commit is signed off... git commit -s @dmcgowan I assume we're still checking for it but I don't see the DCO bot |
|
@caniszczyk Travis is checking, which is causing the failure. We currently don't use a separate check and just have it as part of the Travis run. @lucperkins sign off then looks good. Could you also squash some of the commits, makes signing off much easier and would prefer to remove commits which add then remove files in the same PR. |
|
@dmcgowan I didn't see your note and squashed everything into a single commit. I hope that's okay! |
docs/README.md
Outdated
| To build the site locally (using Docker): | ||
|
|
||
| ```bash | ||
| $ docker run -it -v $(pwd):/src -p "1313:1313" jojomi/hugo |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is -it required?
Also, probably --rm is expected?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think that there's really a use case for just building the site using Docker, so I removed these instructions and left only the instructions below for "watch" mode.
|
@lucperkins site looks good! There are a couple validation checks still failing. DCO check is complaining of some trailing whitespace: Also, the |
|
@ehazlett Done. I also added a |
Codecov Report
@@ Coverage Diff @@
## master #2342 +/- ##
==========================================
- Coverage 44.98% 41.24% -3.75%
==========================================
Files 92 66 -26
Lines 9340 7787 -1553
==========================================
- Hits 4202 3212 -990
+ Misses 4459 4071 -388
+ Partials 679 504 -175
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Signed-off-by: Luc Perkins <lucperkins@gmail.com>
|
LGTM |
|
nice work @lucperkins |
|
It looks like this broke all the links in the README which pointed at github Where is this page https://github.com/containerd/containerd/blob/master/docs/content/docs/getting-started.md available on https://containerd.io ? I don't see any links to it, and I can't seem to guess the url from the path. |
|
Hmm..looks like we didn't catch the few markdown files which were effectively mixed into the The getting started was not intended for the website as it was just a doc for GH linked from the master README.md. We need a follow-up PR that pulls non-website files back into |
|
Just a suggestion, maybe the hugo site root could move to |
This PR migrates the current website from Jekyll to Hugo and updates both the documentation for running the site locally and the build process.
Fixes issue #2342.
@dmcgowan I may need a bit of guidance with this in ensuring a graceful transition.