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

initial netlify + hugo setup #268

Merged
merged 23 commits into from Feb 8, 2019

Conversation

@BenTheElder
Copy link
Member

commented Feb 5, 2019

This is extremely minimal and rough -- I opted to start by borrowing a few ideas from my past experience with hugo just to get something rough up and running.

EDIT: once the netlify preview is working I will add some more CSS, meta-docs, etc.

@k8s-ci-robot

This comment has been minimized.

Copy link
Contributor

commented Feb 5, 2019

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: BenTheElder

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

@k8s-ci-robot k8s-ci-robot requested review from krzyzacy and munnerz Feb 5, 2019

@k8s-ci-robot k8s-ci-robot added the size/L label Feb 5, 2019

@BenTheElder BenTheElder force-pushed the BenTheElder:netlify branch 2 times, most recently from fe63b2e to 51c610d Feb 5, 2019

@BenTheElder

This comment has been minimized.

Copy link
Member Author

commented Feb 5, 2019

https://5c593f55b217340008f75190--kindocs.netlify.com/ :-)
no navigation, no styles, not much of a landing page, but it's rendering the markdown and generally working.

will iterate on fixing some of that first.

@neolit123

This comment has been minimized.

Copy link
Contributor

commented Feb 5, 2019

like i've mentioned on zoom it seems kind of strange (overkill) to use hugo/netlify and a separate website for kind. test-infra or k/community don't have one, but maybe they should too.

let me know when you need a LGTM here.

@neolit123

This comment has been minimized.

Copy link
Contributor

commented Feb 5, 2019

/kind documentation
/priority important-longterm

@BenTheElder

This comment has been minimized.

Copy link
Member Author

commented Feb 5, 2019

test-infra or k/community don't have one, but maybe they should too.

contributor.k8s.io is going to be a thing ~ for k/community.

I also would like to figure out docs for Prow at least sometime after this.

It may be slightly overkill, but everywhere I've found really good docs a site generator is being used to automate things and give better navigation / discoverability, and not all of our content can go on the main site.

The power should be a little more clear once we get the template in shape and more content. The actual content writing will be roughly the same amount of effort.

@BenTheElder

This comment has been minimized.

Copy link
Member Author

commented Feb 5, 2019

kind should have really good docs for all of:

  • quick overview
  • usage & scenarios
  • library usage
  • development / contributing
  • design details
  • roadmap

We're headed that way, but I think we can push the quality higher 😅

@BenTheElder

This comment has been minimized.

Copy link
Member Author

commented Feb 5, 2019

cc @alejandrox1
so basically we have a super lite hugo theme in:

site/assets
site/layouts

and the docs markdown is now in:

site/content

and can be viewed locally with make -C site serve (and then open localhost:1313)

README.md for directories should be _index.md instead, and drop the .md from relative doc links.

Later on we can improve or switch themes and add navigation, a homepage, etc.
We should also begin to add more content. EG I plan to add more details to the contributing guide, and some more more specific usage guides.

@BenTheElder BenTheElder force-pushed the BenTheElder:netlify branch 2 times, most recently from cf40ec4 to 18883d7 Feb 6, 2019

@BenTheElder

This comment has been minimized.

Copy link
Member Author

commented Feb 6, 2019

rendered: https://deploy-preview-268--kindocs.netlify.com/

still hacking on this intermittently between some other work, but it's coming along.
in particular see: https://deploy-preview-268--kindocs.netlify.com/docs/

the markdown rendering is pretty good now. will look at navigation and a footer later.

@neolit123

This comment has been minimized.

Copy link
Contributor

commented Feb 6, 2019

awesome, looks good.
will have a more detailed look at the diff tomorrow!

/assign

@BenTheElder

This comment has been minimized.

Copy link
Member Author

commented Feb 6, 2019

Thanks! Apologies for the big diff, had to move everything around to bootstrap and I've had to fix some links etc. in addition to the actual hugo / netlify configs.

@alejandrox1

This comment has been minimized.

Copy link
Contributor

commented Feb 6, 2019

This looks good! Time to explore
/assign

BenTheElder added some commits Feb 5, 2019

@BenTheElder BenTheElder force-pushed the BenTheElder:netlify branch from 250d8d7 to d328a57 Feb 8, 2019

BenTheElder added some commits Feb 8, 2019

@k8s-ci-robot k8s-ci-robot added size/XL and removed size/L labels Feb 8, 2019

BenTheElder added some commits Feb 8, 2019

@BenTheElder BenTheElder changed the title [WIP] barebones netlify + hugo setup barebones netlify + hugo setup Feb 8, 2019

@BenTheElder BenTheElder changed the title barebones netlify + hugo setup initial netlify + hugo setup Feb 8, 2019

BenTheElder added some commits Feb 8, 2019

@munnerz

This comment has been minimized.

Copy link
Member

commented Feb 8, 2019

Added tide/squash label 😄

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm label Feb 8, 2019

@k8s-ci-robot k8s-ci-robot merged commit bee3dac into kubernetes-sigs:master Feb 8, 2019

10 of 13 checks passed

Header rules - kindocs No header rules processed
Details
Pages changed - kindocs 2 new files uploaded
Details
Redirect rules - kindocs No redirect rules processed
Details
Mixed content - kindocs No mixed content detected
Details
cla/linuxfoundation BenTheElder authorized
Details
netlify/kindocs/deploy-preview Deploy preview ready!
Details
pull-kind-build Job succeeded.
Details
pull-kind-conformance-parallel Job succeeded.
Details
pull-kind-conformance-parallel-1-11 Job succeeded.
Details
pull-kind-conformance-parallel-1-12 Job succeeded.
Details
pull-kind-conformance-parallel-1-13 Job succeeded.
Details
pull-kind-verify Job succeeded.
Details
tide In merge pool.
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.