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

@BenTheElder BenTheElder 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 k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Feb 5, 2019
@k8s-ci-robot
Copy link
Contributor

[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 added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 5, 2019
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 5, 2019
@BenTheElder
Copy link
Member Author

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
Copy link
Member

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
Copy link
Member

/kind documentation
/priority important-longterm

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. labels Feb 5, 2019
@BenTheElder
Copy link
Member Author

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
Copy link
Member Author

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
Copy link
Member Author

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
Copy link
Member Author

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
Copy link
Member

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

/assign

@BenTheElder
Copy link
Member Author

BenTheElder 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
Copy link
Contributor

alejandrox1 commented Feb 6, 2019

This looks good! Time to explore
/assign

@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 8, 2019
@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 8, 2019
@BenTheElder BenTheElder changed the title [WIP] barebones netlify + hugo setup barebones netlify + hugo setup Feb 8, 2019
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 8, 2019
@BenTheElder BenTheElder changed the title barebones netlify + hugo setup initial netlify + hugo setup Feb 8, 2019
@munnerz munnerz added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Feb 8, 2019
@munnerz
Copy link
Member

munnerz commented Feb 8, 2019

Added tide/squash label 😄

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 8, 2019
@k8s-ci-robot k8s-ci-robot merged commit bee3dac into kubernetes-sigs:master Feb 8, 2019
@BenTheElder BenTheElder deleted the netlify branch July 19, 2020 23:48
yankay pushed a commit to yankay/kind that referenced this pull request Mar 17, 2022
Added KPNG_DEBUG_LEVEL environment  variable
@lbrpsoftware
Copy link

What do you think about Notion?
They are working on it!
I don't know a faster way to EDIT

@lbrpsoftware
Copy link

A little quick DEMO
I'm not Notion, just think it's great!
Specially the new GitHub connection!

@lbrpsoftware
Copy link

skiddy

stg-0 added a commit to stg-0/kind that referenced this pull request Sep 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants